Skip to main content
GET
/
api
/
objects
/
{objectType}
List objects or fetch by ID
curl --request GET \
  --url https://app.useitem.io/api/objects/{objectType} \
  --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"
    }
  ],
  "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.

Query Parameters

​
id
integer

Fetch a single object by ID. When provided, returns one object instead of a list.

​
email
string

Fetch a contact by email (contacts only). When provided, returns one object.

​
limit
integer
default:50

Maximum records to return (list mode only). Default: 50, max: 200.

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

Number of records to skip for pagination (list mode only).

​
search
string

Text search on name (and email for contacts).

​
sort_by
string
default:created_at

Field to sort by. Default: created_at.

​
sort_order
enum<string>
default:desc

Sort direction. Default: desc.

Available options:
asc,
desc
​
filter[{field_name}]
string

Filter by field value (case-insensitive partial match). Works with both system fields and custom fields.

Example: filter[industry]=Technology

​
include_all_fields
boolean
default:false

Include all system fields in the response (single-object mode only).

​
include_summary
boolean
default:false

Include the AI-generated summary (contacts and companies only, single-object mode).

Response

Success

​
data
object[]
​
pagination
object