Get calls log
Get a list of calls from a given workspace ID
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
Query parameters
limitinteger · min: 1 · max: 1000OptionalDefault:
Limits the number of results to return
10
pageTokenstring · max: 8000Optional
Pagination token that keeps of track of the current position in the list
startAtstring · date-timeOptional
Start date for the query
endAtstring · date-timeOptional
End date for the query
channelIdstring[]Optional
The ID for a channel
statusstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
tostring · min: 1 · max: 100Optional
fromstring · min: 1 · max: 100Optional
durationintegerOptional
directionstring · enumOptionalPossible values:
idstring · uuidOptional
The ID for a call
tagstring[]Optional
Filter based on tag
Responses
200
OK
application/json
Responseall of
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
get
GET /workspaces/{workspaceId}/channels/calls HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"from": "text",
"to": "text",
"originator": {
"contact": {
"id": "text",
"identifierKey": "text",
"identifierValue": "text"
},
"number": {
"type": "pstn",
"number": "text",
"anonymous": true,
"callerIdName": "text",
"identity": "text",
"countryIsoCode": "text",
"pstnNumberType": "text"
}
},
"receiver": {
"contact": {
"id": "text",
"identifierKey": "text",
"identifierValue": "text"
},
"number": {
"type": "pstn",
"number": "text",
"anonymous": true,
"callerIdName": "text",
"identity": "text",
"countryIsoCode": "text",
"pstnNumberType": "text"
}
},
"parentId": "123e4567-e89b-12d3-a456-426614174000",
"direction": "incoming",
"status": "accepted",
"reason": "text",
"type": "pstn",
"duration": 1,
"hangupCauseCode": 1,
"hangupSource": "callee",
"hangupSipCode": "text",
"createdAt": "2025-07-24T04:52:10.439Z",
"updatedAt": "2025-07-24T04:52:10.439Z",
"ringingAt": "2025-07-24T04:52:10.439Z",
"answeredAt": "2025-07-24T04:52:10.439Z",
"endedAt": "2025-07-24T04:52:10.439Z",
"scheduledFor": "2025-07-24T04:52:10.439Z",
"callFlow": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"commands": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"callId": "123e4567-e89b-12d3-a456-426614174000",
"callFlowId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"command": "text",
"conditions": [
{
"variable": "keys",
"operator": "eq",
"value": "text"
}
]
}
]
},
"notification": {
"url": "text"
},
"qualityInsights": {
"mos": "text",
"pdd": "text"
},
"sipInsights": {
"hangupSipCode": "text",
"edgeRegion": "text",
"providerName": "text",
"userAgent": "text",
"remoteSignallingIp": "text",
"remoteMediaIp": "text"
},
"amdResult": {
"result": "human",
"speech": "text",
"locale": "text"
},
"sipType": "elastic",
"tags": [
"text"
]
}
],
"nextPageToken": "text"
}
Last updated
Was this helpful?