Skip to main content
GET
Execute a view

Authorizations

x-api-key
string
header
required

Your organization's API key (starts with sk_live_)

Path Parameters

objectType
string
required

The object type slug. Use contacts for People, companies for Companies, or the slug of a Custom Object (e.g., deals, tickets).

Singular forms (contact, company) are also accepted.

viewId
string<uuid>
required

The view ID (UUID) from the List Views endpoint.

Query Parameters

limit
integer
default:50

Maximum records to return. Default: 50, max: 200.

Required range: x <= 200
offset
integer
default:0

Number of records to skip for pagination.

Response

View results

data
object[]
view
object
pagination
object