Skip to main content
GET
/
v2
/
lists
/
{listId}
Get metadata on a single List
curl --request GET \
  --url https://api.affinity.co/v2/lists/{listId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "name": "My Companies",
  "type": "company",
  "isPublic": false,
  "ownerId": 1,
  "creatorId": 1
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
listId
integer<int64>
required

List ID

Required range: 1 <= x <= 9007199254740991

Response

OK

ListWithType model

​
id
integer<int64>
required

The unique identifier for the list

Required range: 1 <= x <= 9007199254740991
Example:

1

​
name
string
required

The name of the list

Example:

"All companies"

​
creatorId
integer<int64>
required

The ID of the user that created this list

Required range: 1 <= x <= 9007199254740991
Example:

1

​
ownerId
integer<int64>
required

The ID of the user that owns this list

Required range: 1 <= x <= 9007199254740991
Example:

1

​
isPublic
boolean
required

Whether or not the list is public

Example:

false

​
type
enum<string>
required

The entity type for this list

Available options:
company,
opportunity,
person
Example:

"company"