- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Intent
lists
Returns the saved lists of your organization, with their materializations.
Intent. This intent is a read. It returns data and changes nothing.
Returns the saved lists of your organization, with their materializations. A list stores a search and the fields to export, or an input file to enrich.
Signature
Section titled “Signature”lists(input: SearchListsInput): ListConnectionReturns ListConnection.
| Field | Type | Part | Description |
|---|---|---|---|
id |
ID |
Match | The ID of a list. The query returns only this list. |
name |
String |
Match | A part of a list name. The query returns the lists whose names contain this text, in uppercase or lowercase. |
conditions |
ConnectionConditions |
Condition | The filter and sort settings for the lists. |
first |
Int |
Condition | The number of lists to return, after the after cursor if you set one. Do not use it together with last. |
after |
String |
Condition | A cursor. The query returns the lists after this cursor. Use it together with first. |
last |
Int |
Condition | The number of lists to return before the before cursor. Use it together with before. |
before |
String |
Condition | A cursor. The query returns the lists before this cursor. Use it together with last. |
Example
Section titled “Example”query { lists { edges { node { id customerId workspaceId listType } } }}Response, as returned:
{ "data": { "lists": { "edges": [ { "node": { "id": "00000000-0000-4000-8000-000000000001", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "LIST_GENERATION" } }, { "node": { "id": "00000000-0000-4000-8000-000000000004", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "LIST_GENERATION" } }, { "node": { "id": "00000000-0000-4000-8000-000000000005", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "ENRICHMENT" } }, { "node": { "id": "00000000-0000-4000-8000-000000000006", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "ENRICHMENT" } }, { "node": { "id": "00000000-0000-4000-8000-000000000007", "customerId": "00000000-0000-4000-8000-000000000002", …}