Skip to main content
GET
/
api
/
objects
/
{objectType}
/
views
/
{viewId}
Execute a view
curl --request GET \
  --url https://app.useitem.io/api/objects/{objectType}/views/{viewId} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 123,
      "name": "Alex Johnson",
      "email": "alex@acme.com",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "view": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

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