List API

Several API requests return lists of objects allowing for paging through large result sets. Lists are delivered in chronological order by default.

Attribute

Name Type Description
object string

The string list.

location string

API path to retrieve the current list object.

data array

Returned records.

from datetime

Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

Number of records returned.

offset integer

Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

Order of records returned. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

to datetime

Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

total integer

Total amount of records between from and to.

Example

  • Json Response