DocumentatieEngagement Platform API
Sign inGet started
Guides
API

List conversations

GET
/workspaces/{workspaceId}/conversations
List all conversations across the workspace. This will return a maximum of 100 conversations per page, with 10 as default. You can use the limit and pageToken query parameters to paginate the results. Learn more about pagination in the Common API Usage pagination section.
Queryparameters
limit
integer
pageToken
string
reverse
boolean
resource
string
The resource to find conversation for
Antwoord-payload
results
array of object
verplicht
List of conversations.
Onderliggende attributen tonen
results.accessibility
string
verplicht
Possible values: open, invite-only, request-to-join, private
results.activeParticipantCount
integer
verplicht
results.assigneeId
string
results.attributes
object
results.category
string
results.channelId
string
verplicht
results.createdAt
string
verplicht
results.description
string
results.directory
string
results.featuredParticipants
array of object
verplicht
Onderliggende attributen tonen
results.featuredParticipants.avatarUrl
string
results.featuredParticipants.contact
object
Onderliggende attributen tonen
results.featuredParticipants.contact.identifierKey
string
verplicht
results.featuredParticipants.contact.identifierValue
string
verplicht
results.featuredParticipants.contact.platformAddress
string
results.featuredParticipants.contact.platformAddressSelector
string
results.featuredParticipants.conversationId
string
results.featuredParticipants.createdAt
string
results.featuredParticipants.displayName
string
results.featuredParticipants.id
string
verplicht
results.featuredParticipants.resourceUri
string
results.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
results.featuredParticipants.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.featuredParticipants.updatedAt
string
results.hasDraft
boolean
results.id
string
verplicht
results.inbox
object
Onderliggende attributen tonen
results.inbox.id
string
verplicht
results.inbox.identifier
string
verplicht
results.inbox.ownerId
string
verplicht
results.inbox.ownerType
string
verplicht
Possible values: user, group
results.inbox.type
string
verplicht
Possible values: personal, shared, support
results.initiatingParticipant
object
Onderliggende attributen tonen
results.initiatingParticipant.avatarUrl
string
results.initiatingParticipant.contact
object
Onderliggende attributen tonen
results.initiatingParticipant.contact.identifierKey
string
verplicht
results.initiatingParticipant.contact.identifierValue
string
verplicht
results.initiatingParticipant.contact.platformAddress
string
results.initiatingParticipant.contact.platformAddressSelector
string
results.initiatingParticipant.conversationId
string
results.initiatingParticipant.createdAt
string
results.initiatingParticipant.displayName
string
results.initiatingParticipant.id
string
verplicht
results.initiatingParticipant.resourceUri
string
results.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
results.initiatingParticipant.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.initiatingParticipant.updatedAt
string
results.lastMessage
object
Onderliggende attributen tonen
results.lastMessage.createdAt
string
verplicht
results.lastMessage.draft
boolean
verplicht
results.lastMessage.id
string
verplicht
results.lastMessage.preview
object
verplicht
Onderliggende attributen tonen
results.lastMessage.preview.text
string
results.lastMessage.recipients
array of object
Onderliggende attributen tonen
results.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
results.lastMessage.recipients.contactAnnotation.name
string
results.lastMessage.recipients.countryCode
string
results.lastMessage.recipients.id
string
The ID of the contact.
results.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
results.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Onderliggende attributen tonen
results.lastMessage.recipients.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.lastMessage.recipients.identifiers.identifierValue
string
verplicht
The identifier value for finding the contact.
results.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.lastMessage.recipients.receiverExpression
string
results.lastMessage.recipients.receiverValue
string
results.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.lastMessage.sender
object
Onderliggende attributen tonen
results.lastMessage.sender.email
string
results.lastMessage.sender.name
string
results.lastMessage.sender.avatarUrl
string
results.lastMessage.sender.contact
object
Onderliggende attributen tonen
results.lastMessage.sender.contact.identifierKey
string
verplicht
results.lastMessage.sender.contact.identifierValue
string
verplicht
results.lastMessage.sender.contact.platformAddress
string
results.lastMessage.sender.contact.platformAddressSelector
string
results.lastMessage.sender.conversationId
string
results.lastMessage.sender.createdAt
string
results.lastMessage.sender.displayName
string
results.lastMessage.sender.id
string
verplicht
results.lastMessage.sender.resourceUri
string
results.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
results.lastMessage.sender.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.lastMessage.sender.updatedAt
string
results.lastMessage.status
string
verplicht
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.lastMessage.type
string
verplicht
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
results.lastMessageIncomingAt
string
results.lastMessageOutgoingAt
string
results.name
string
verplicht
results.participants
array of object
Onderliggende attributen tonen
results.participants.contact
object
Onderliggende attributen tonen
results.participants.contact.identifierKey
string
verplicht
results.participants.contact.identifierValue
string
verplicht
results.participants.contact.platformAddress
string
results.participants.contact.platformAddressSelector
string
results.participants.id
string
verplicht
results.participants.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.pendingParticipantCount
integer
results.platformStyle
string
verplicht
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
results.privateAttributes
string
results.read
boolean
results.referral
object
Onderliggende attributen tonen
results.referral.caption
string
results.referral.mediaType
string
results.referral.mediaUrl
string
results.referral.sourceId
string
verplicht
results.referral.sourceType
string
results.referral.sourceUrl
string
results.referral.text
string
results.referral.timestamp
string
results.referral.title
string
results.referral.username
string
results.resource
object
Onderliggende attributen tonen
results.resource.id
string
verplicht
results.resource.type
string
verplicht
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
results.resourceUri
string
results.starred
boolean
results.status
string
verplicht
Possible values: deleted, active, closed, spam, archived
results.style
string
verplicht
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
results.summary
string
results.tags
array of string
results.updatedAt
string
verplicht
results.visibility
string
verplicht
Possible values: public, private, direct, group
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
total
integer
totalType
string
Possible values: ``, equal, greaterThanOrEqual
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/conversations' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Codevoorbeeld
curl "https://api.bird.com/workspaces/e58899bf-1e8d-4ff7-b9db-a60befaf90d2/conversations" \
-H "Authorization: AccessKey abcd"
Note: if there are more than 10 conversations, the results may be paginated. Please refer to Pagination on how to use nextPageToken.