Skip to main content
GET
/
objects
/
{object_name}
/
records
cURL
curl --request GET \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "data": [
    {
      "object": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "attributes": {}
    }
  ],
  "cursor": "<string>"
}

​
Overview

The list method retrieves a paginated list of records from the specified object. You can use query parameters to filter, sort, and paginate through the results. Pagination is “cursor-based” which means that you can provide the cursor from the previous response to get the next page of results. This improves performance on large datasets.
The ability to search, filter, and reorder results is coming soon!

​
Examples

This retrieves the first page of company records:
GET /objects/company/records
The response contains an additional property cursor that provides a token that can be passed in the next response:
GET /objects/company/records?cursor=b034dc5a-c0c1-49b2-86c8-025cfb1ed2eb
Once cursor is null, you have reached the end of the records.
You can customize the number of records returned per page with the limit query parameter:
GET /objects/person/records?limit=10
The maximum page size you can set is 1,000.

​
Usage

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
object_name
string
required

Query Parameters

​
limit
integer

Limit the number of records returned. Default is 100.

Required range: 1 <= x <= 1000
​
cursor
string

Cursor from the previous response to resume pagination from.

Response

Response for a successful list operation with cursor-based pagination.

​
status
enum<string>
required
Available options:
success
​
data
object[]
required
​
cursor
string | null
required
⌘I