Affinity logo

calls

Operations about calls

Get metadata on all Calls

Paginate through all calls in Affinity. Returns basic information about the call interaction and its participants. Will only return calls that the current authenticated user has permission to see.

You can filter calls using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.

Property Name Description Type Allowed Operators Examples
id Unique identifier for Calls int64 = id=1
startTime Start time of when the Call was held datetime >, <, >=, <= sentAt>2025-01-01T01:00:00Z
createdAt When the Call was created in Affinity datetime >, <, >=, <= createdAt<2025-01-01T01:00:00Z
updatedAt When the Call was updated in Affinity datetime >, <, >=, <= updatedAt>=2025-01-01T01:00:00Z
SecuritybearerAuth
Request
query Parameters
cursor
string

Cursor for the next or previous page

Example: cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Number of items to include in the page

Example: limit=100
filter
string

Filter options

Example: filter=id=1234
Responses
200

OK

Response Headers
X-Ratelimit-Limit-User
integer

Number of requests allowed per minute for the user

X-Ratelimit-Limit-User-Remaining
integer

Number of requests remaining for the user

X-Ratelimit-Limit-User-Reset
integer

Time in seconds before the limit resets for the user

X-Ratelimit-Limit-Org
integer

Number of requests allowed per month for the account

X-Ratelimit-Limit-Org-Remaining
integer

Number of requests remaining for the account

X-Ratelimit-Limit-Org-Reset
integer

Time in seconds before the limit resets for the account

Response Schema: application/json
required
Array of objects (interactions.Call) <= 100 items

A page of Call results

Array (<= 100 items)
id
required
integer <int64> [ 1 .. 9007199254740991 ]

The call's unique identifier

loggingType
required
string

Indicates how the interaction was added to Affinity: either manually by a user ('manual') or automatically through Affinity's capture process ('automated'). Currently, calls can only be logged as 'manual'.

Value: "manual"
title
required
string or null

The call's title

startTime
required
string <date-time>

The timestamp of when the call starts

endTime
required
string or null <date-time>

The timestamp of when the call ends

allDay
required
boolean

Whether the call is all day

required
Attendee (object) or null

The person who created the call

createdAt
required
string <date-time>

The timestamp of when the call was created

updatedAt
required
string or null <date-time>

The timestamp of when the call was updated

required
object (AttendeesPreview)

A preview of the attendees in the call

required
object (Pagination)
prevUrl
string or null <uri>

URL for the previous page

nextUrl
string or null <uri>

URL for the next page

400

Bad Request

default

Errors

get/v2/calls
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {}
}
➔ Next to chatMessages