Skip to main content
GET
/
v2
/
lists
Get metadata on all Lists
curl --request GET \
  --url https://api.affinity.co/v2/lists \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "name": "My Companies",
      "type": "company",
      "isPublic": false,
      "ownerId": 1,
      "creatorId": 1
    },
    {
      "id": 2,
      "name": "My Persons",
      "type": "person",
      "isPublic": false,
      "ownerId": 1,
      "creatorId": 1
    },
    {
      "id": 3,
      "name": "My Opportunities",
      "type": "opportunity",
      "isPublic": false,
      "ownerId": 1,
      "creatorId": 1
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/lists?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/lists?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

Response

OK

ListWithTypePaged model

​
data
ListWithType · object[]
required

A page of ListWithType results

Maximum array length: 100
​
pagination
Pagination · object
required
Example:
{
  "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
  "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}