Lists

Create a list

Save a search with filters, or the people you picked with record_ids. The answer comes back at once: a saved search fills itself in the background (materialize has the job), and GET /api/v1/lists/{list_id}/fill says when it is done. Every filter applies, the same as in search. Saving costs nothing and reveals no contacts.

Cost	What it does	Key scopes
Free	Writes	argorant:manage_lists

post/api/v1/lists

Request

Base URL: https://app.argorant.com
URL: https://app.argorant.com/api/v1/lists
Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

namestring required

List name, up to 200 characters.

record_idsstring[]

Or exactly these people, by record id.

Example request

{
  "name": "DACH CFOs"
}

Response

Created

list_idinteger

List id.

namestring

List name.

record_type'person' | 'company'

What the list holds.

selection_mode'filtered' | 'records'

filtered: a saved search that follows its filters. records: the people you picked.

filtersobject

The search filters of a saved search.

snapshot_totalinteger

How many matched when the list was saved.

item_countinteger

People stored in the list.

created_atstring date-time nullable

When it was created.

updated_atstring date-time nullable

When it last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.