Get all people lists

curl --request GET \
  --url https://app.tryspecter.com/api/v1/lists/people \
  --header 'X-API-Key: <api-key>'

[
  {
    "id": "b73c8bed-3b92-48f9-a879-40ee114dca03",
    "name": "Favourites",
    "created_at": "2024-11-14T10:36:12.625Z",
    "updated_at": "2024-11-14T10:36:12.625Z",
    "is_global": false,
    "people_count": 10,
    "shared_with": [
      "user_2PFJ2V8IR837k6TPguVCIFhNsWA"
    ]
  }
]

People Lists

Get all people lists

What it does

Returns all people lists available to your API key—lists created via the API, shared with the API in the UI, or shared globally.

Why you’d use it

Discover which people cohorts you can work with and see their sizes before fetching individual records.

Key behaviours

Each list object includes the number of people in the list.
To retrieve the people IDs in a list, call the corresponding GET endpoint with that list’s ID.
Only lists that meet the availability criteria above are returned.

GET

lists

people

Get all people lists

curl --request GET \
  --url https://app.tryspecter.com/api/v1/lists/people \
  --header 'X-API-Key: <api-key>'

[
  {
    "id": "b73c8bed-3b92-48f9-a879-40ee114dca03",
    "name": "Favourites",
    "created_at": "2024-11-14T10:36:12.625Z",
    "updated_at": "2024-11-14T10:36:12.625Z",
    "is_global": false,
    "people_count": 10,
    "shared_with": [
      "user_2PFJ2V8IR837k6TPguVCIFhNsWA"
    ]
  }
]

Authorizations

X-API-Key

string

header

required

Response

The people lists

string

List Id

Example:

"b73c8bed-3b92-48f9-a879-40ee114dca03"

name

string

Name of the list

Example:

"Favourites"

created_at

string<date-time>

Date list was created

Example:

"2024-11-14T10:36:12.625Z"

updated_at

string<date-time>

Date the list was last updated

Example:

"2024-11-14T10:36:12.625Z"

is_global

boolean

This flags lists recommended by Specter for all users

Example:

false

people_count

number

The number of people in this list

Example:

10

shared_with

string[]

The user ids of the users this list is shared with

User Id

Delete a company list Get specific people list info

Documentation Index

Authorizations

Response