All Record Lists

📘

Supported Regions and Base URLs

Scope

record-lists:manage

Body Response - Schema

200 (get the list of record lists - list with the paginated samples)

ParameterTypeDescriptionRequired
totalintegerthe number of itemsyes
per_pageintegerthe number of items per pageyes
countintegerthe total number of items in this pageno
pageintegerthe number of the current pageyes
total_pagesintegerthe total number of pagesno
_linksobjectHAL API related links.
"_links" subdivides into:

1 - "next" (object) - link of the next page. Required.
1.1 - "href" (string) - address of the resource. Required.

2 - "last" (object) - link of the last page. Required.
2.1 - "href" (string) - address of the resource. Required.

3 - "prev" (object) - link of the previous page. Required.
3.1 - "href" (string) - address of the resource. Required.

4 - "self" (object) - link of the current page. Required.
4.1 - "href" (string) - address of the resource. Required.

5 - "first" (object) - link of the first page. Required.
5.1 - "href" (string) - address of the resource. Required.
yes
_embeddedobject"_embedded" subdivides into:

1 - "record_lists" (array[object]) - list of record lists paginated. Required.

1.1 - "id" (string) - ID of the record list created.

1.2 - "name" (string) - record list name.

1.3 - "unique_identifier_type" (string) - duplicate checking logic configured for the record list:
PHONE_NUMBER - duplicate checking based on the record's phone_number.
EXTERNAL - duplicate checking based on the record's external_id and external_provider.
NOTHING - no duplicate checking.

1.4 - "created_at" (string) - record list creation date.

1.5 - "updated_at" (string) - record list updated date.

1.6 - "status" (string) - status of validation process done on the record list csv file. Allowed values:
REJECTED
VALIDATION_STARTED
UPLOADED
ACCEPTED
INCOMPLETE
* CORRUPTED

1.7 - "records_count" (integer) - how many records are present in the record list.

1.8 - "teams" (array[object]) - teams that this record belongs to.
1.8.1 - "id" (string) - the team ID of the record list.
1.8.2 - "name" (string) - the team ID of the record list.
1.8.3 - "_links" (object)
1.8.3.1 - "self" (object)
1.8.3.1.1 - "href" (string)

1.9 - "_links" (object)
1.9.1 - "self" (object)
1.9.1.1 - "href" (string)
no
Language
Click Try It! to start a request and see the response here!