Skip to main content
GET
/
transcripts
/
{projectID}
Fetch Project Transcripts
curl --request GET \
  --url https://api.voiceflow.com/v2/transcripts/{projectID} \
  --header 'Authorization: <api-key>'
[
  {
    "sessionID": "<string>",
    "_id": "<string>",
    "projectID": "<string>",
    "browser": "chrome, safari",
    "device": "desktop, mobile",
    "os": "macos, windows, linux",
    "reportTags": [
      "<string>"
    ],
    "unread": true,
    "annotations": {
      "_id": {
        "utteranceAddedCount": 123,
        "utteranceAddedTo": "<string>"
      }
    },
    "creatorID": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "user": {
      "name": "John Doe",
      "image": "https://creator.voiceflow.com/assets/vf-logo-f0e2d8a2.png"
    }
  }
]

Authorizations

​
Authorization
string
header
required

All requests made to the Project API must be validated with the project DM API Key.

Path Parameters

​
projectID
string
required

Voiceflow project ID

Example:

"63204daf2c4a550006873772"

Query Parameters

​
tag
string

filter transcripts by tag

Example:

"system.reviewed"

​
range
enum<string>

filter transcripts by end date

Available options:
Today,
Yesterday,
Last 7 Days,
Last 30 days,
All time
Example:

"All time"

​
startDate
string

filter transcripts by start date

Example:

"2023-01-01"

​
endDate
string

filter transcripts by end date

Example:

"2023-01-01"

Response

200 - application/json

OK

​
sessionID
string
required

The ID of the conversation session to record as a transcript. This should be the same value as the userID property of the Dialog API.

​
_id
string

the transcript ID

​
projectID
string

the project ID that the transcript belongs to

​
browser
string

the browser that was used when for the interaction

Example:

"chrome, safari"

​
device
string

the device that was used when for the interaction

Example:

"desktop, mobile"

​
os
string

the operating system that was used when for the interaction

Example:

"macos, windows, linux"

​
reportTags
string[]

the tags associated with the transcript

​
unread
boolean

true if the transcrip is unread, false otherwise

​
annotations
object

the transcript ID

​
creatorID
string

the ID of the user who created the transcript

​
createdAt
string

the date time the transcript was created

​
updatedAt
string

the date time the transcript was updated

​
user
object