Get all Users

curl --request GET \
  --url https://api.affinity.co/v2/users \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "firstName": "Jane",
      "lastName": "Doe",
      "primaryEmailAddress": "jane.doe@acme.co",
      "photoUrl": "https://assets.affinity.co/img/avatars/jane-doe.png",
      "status": "active",
      "emailAddresses": [
        "jane.doe@acme.co",
        "janedoe@gmail.com"
      ],
      "role": "standard"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Users

Get all Users

⚠️ This endpoint is currently in BETA

Paginate through internal Users in your organization.

Returns information about each User, including name, primary email address, all email addresses, photo URL, account status, and account role.

The emailAddresses and role properties are only returned to callers with the “Manage Users” permission.

Use the optional term parameter to filter by first name, last name, or primary email address.

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

Property Name	Type	Allowed Operators	Examples
`id`	`int32`	`=`	`id=1\|id=2\|id=3`
`status`	`enum`	`=`	`status=active`

GET

users

Get all Users

curl --request GET \
  --url https://api.affinity.co/v2/users \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "firstName": "Jane",
      "lastName": "Doe",
      "primaryEmailAddress": "jane.doe@acme.co",
      "photoUrl": "https://assets.affinity.co/img/avatars/jane-doe.png",
      "status": "active",
      "emailAddresses": [
        "jane.doe@acme.co",
        "janedoe@gmail.com"
      ],
      "role": "standard"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor

string

Cursor for the next or previous page

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

limit

integer<int32>

default:100

Number of items to include in the page

Required range: 1 <= x <= 100

Example:

100

term

string

Case-insensitive search across first name, last name, and primary email address. Returns users matching the term as a substring.

Example:

"jane"

filter

string

Filter options

Response

A paginated list of Users

data

UserData · object[]

required

A page of UserData results

Maximum array length: 100

Show child attributes

pagination

Pagination · object

required

Show child attributes

Get fragments of a transcript Get a single User

⌘I