AFaffinity
Lists

Get metadata on a single List

Changed on

Retrieve detailed information about a specific List you have access to view. Returns List configuration including name, owner, privacy settings, and creation details.

get/v2/lists/{listId}

Request

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

Path parameters

listIdinteger required

List ID

Response

OK

idinteger required

The unique identifier for the list

namestring required

The name of the list

creatorIdinteger required

The ID of the user that created this list

ownerIdinteger required

The ID of the user that owns this list

isPublicboolean required

Whether or not the list is public

type'company' | 'opportunity' | 'person' required

The entity type for this list

createdAtstring date-time required

The date and time the list was created

Example response

{
  "id": 1,
  "name": "All companies",
  "creatorId": 1,
  "ownerId": 1,
  "type": "company",
  "createdAt": "2024-03-07T20:21:42Z"
}

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