Get lists

The method allows getting a list of available lists.

Limitations
The method is available for users with access to lists

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

The method returns an array of list objects.

ParameterData typeDescription
idintList ID
namestringList name
created_byintThe ID of the user who created the list
updated_byintThe ID of the user who edited the list last
created_atintList creation date in Unix Timestamp format
updated_atintList edit date in Unix Timestamp format
sortintList sorting
typestringList type
can_link_multipleboolIt shows if one element of the current list can be linked to several leads
can_be_deletedboolIt shows if a list can be deleted via the interface
account_idintAccount ID where the list is located in
Query Params
int32

A page of response

int32

The number of the entities returned in the response of one request (limit – 250)

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json