Skip to main content
GET
/
v2
/
users
Get all Users
curl --request GET \
  --url https://api.affinity.co/v2/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1073741824,
      "firstName": "<string>",
      "lastName": "<string>",
      "primaryEmailAddress": "jsmith@example.com",
      "photoUrl": "<string>",
      "emailAddresses": [
        "jsmith@example.com"
      ],
      "role": "<string>"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.affinity.co/llms.txt

Use this file to discover all available pages before exploring further.

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

OK

A paginated list of Users

data
UserData · object[]
required

A page of UserData results

Maximum array length: 100
pagination
Pagination · object
required