AFaffinity
Lists

Get metadata on all Lists

Changed on

Paginate through all Lists in your organization that you have access to view. Returns basic information about each List, including name, owner, and privacy settings.

get/v2/lists

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/lists
  • Auth
    HTTP bearer

Query parameters

termstring

Case-insensitive substring match on List name.

cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger
Example:100

Number of items to include in the page

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "name": "All companies",
      "creatorId": 1,
      "ownerId": 1,
      "type": "company",
      "createdAt": "2024-03-07T20:21:42Z"
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status