List objects or fetch by ID
List mode (no id or email param): Returns a paginated list of objects with optional search, filtering, and sorting.
Single-object mode (with id or email): Returns a single object by ID or email lookup.
Request
- Base URLhttps://app.useitem.io
- AuthAPI key in header x-api-key
Query parameters
Fetch a single object by ID. When provided, returns one object instead of a list.
Fetch a contact by email (contacts only). When provided, returns one object.
Maximum records to return (list mode only). Default: 50, max: 200.
Number of records to skip for pagination (list mode only).
Text search on name (and email for contacts).
Field to sort by. Default: created_at.
Sort direction. Default: desc.
Filter by field value (case-insensitive partial match). Works with both system fields and custom fields.
Example: filter[industry]=Technology
Include all system fields in the response (single-object mode only).
Include the AI-generated summary (contacts and companies only, single-object mode).
Response
Success
Example response
{
"data": [
{
"id": 123,
"name": "Alex Johnson",
"email": "alex@acme.com"
}
],
"pagination": {
"total": 150,
"limit": 50,
"has_more": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.