Skip to main content
GET
List interactions

Authorizations

Authorization
string
header
required

API key for authentication

Query Parameters

cursor
string

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Maximum string length: 512
entity.id
string
required

The person, company, or object linked to interactions.

Required string length: 40
timeframe
enum<string>
required

Whether to list past interactions (most recent first) or upcoming interactions.

Available options:
past,
upcoming
importedTypes

The imported interaction types to include. Repeat the parameter to pass several types. Omit to return every imported type. Pass an empty value (importedTypes=) to return only logged interactions. Logged interactions are always returned.

Available options:
user.id

Only return interactions of these workspace members. Repeat the parameter to pass several users.

Required string length: 40

Response

A paginated list of interactions with optional pagination link.

data
object
required
Example:
deprecations
string[]
Example: