lists list

GET {{baseUrl}}/lists

Returns a list of List objects.

Request Params

KeyDatatypeRequiredDescription
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
include_deleted_databooleanWhether to include data that was marked as deleted by third party webhooks.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
modified_afterstringIf provided, will only return objects modified after this datetime.
modified_beforestringIf provided, will only return objects modified before this datetime.
page_sizenumberNumber of results to return per page.
remote_idstringThe API provider's ID for the given object.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"name":"New Customer List","type":"Static","remote_created_at":"2022-12-23T00:00:00Z","remote_updated_at":"2022-12-23T00:00:00Z","id":"6ce6ceed-94b3-205c-fcd3-3257a7d2f6f5","remote_id":"25"},{"name":"New Customer List","type":"Static","remote_created_at":"2022-12-23T00:00:00Z","remote_updated_at":"2022-12-23T00:00:00Z","id":"f8ed8829-d80d-557e-1c5a-38e87682860d","remote_id":"25"}]}