GET
objects/
User API Service tier
Active custom object definitions in the caller's space(s), with fields.
URL
User API https://sales.mattering.io/api/user/v1/objects/
Service tier https://sales.mattering.io/api/internal/objects/
Query parameters
Responses
200 data and meta envelope
{
"data": {
"objects": [
{
"id": "...",
"key": "...",
"label_singular": "...",
"label_plural": "...",
"description": "...",
"icon": "...",
"color": "...",
"primary_field_key": "...",
"space_id": "...",
"fields": [
{
"key": "...",
"name": "...",
"field_type": "...",
"description": "...",
"is_required": true,
"is_multi": true,
"options": [
"..."
]
}
]
}
]
},
"meta": {
"total": 0
}
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Errors
Status Code
401 unauthorized404 space_not_found_or_forbidden
Example
User API Service tier
curl -X GET "https://sales.mattering.io/api/user/v1/objects/?space_id=..." \
-H "Authorization: Bearer $MATTERING_API_KEY" curl -X GET "https://sales.mattering.io/api/internal/objects/?space_id=..." \
-H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
-H "X-Internal-Org-Id: $ORG_ID" \
-H "X-Internal-User-Email: you@example.com"
Source: CRMCore/object_api.py (object_api.objects)
GET POST
objects/{object_key} /records/
User API Service tier
List (GET) or create (POST) records of one custom object.
URL
User API https://sales.mattering.io/api/user/v1/objects/{object_key} /records/
Service tier https://sales.mattering.io/api/internal/objects/{object_key} /records/
Path parameters
Query parameters
Name Default
keywordnone limitnone offset0space_idnone
Body keys (JSON)
Key Required Default
space_idoptional or conditional none tagsoptional or conditional none valuesoptional or conditional none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Pagination
Accepts limit and offset. Check the response for a total or count field.
Responses
200 data and meta envelope
{
"data": {
"records": [
{
"id": "...",
"object_key": "...",
"display_name": "...",
"data": {
"...": "..."
},
"tags": [
"..."
],
"owner_email": "...",
"space_id": "...",
"is_active": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
]
},
"meta": {
"total": 0,
"limit": 0,
"offset": 0,
"object_key": "..."
}
}
201 data and meta envelope
{
"data": {
"record": {
"id": "...",
"object_key": "...",
"display_name": "...",
"data": {
"...": "..."
},
"tags": [
"..."
],
"owner_email": "...",
"space_id": "...",
"is_active": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
},
"meta": {
"total": 0,
"limit": 0,
"offset": 0
}
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Errors
Status Code
401 unauthorized
Example
User API Service tier
curl -X POST "https://sales.mattering.io/api/user/v1/objects/OBJECT_KEY/records/" \
-H "Authorization: Bearer $MATTERING_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"space_id": "...",
"tags": "...",
"values": "..."
}' curl -X POST "https://sales.mattering.io/api/internal/objects/OBJECT_KEY/records/" \
-H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
-H "X-Internal-Org-Id: $ORG_ID" \
-H "X-Internal-User-Email: you@example.com" \
-H "Content-Type: application/json" \
-d '{
"space_id": "...",
"tags": "...",
"values": "..."
}'
Source: CRMCore/object_api.py (object_api.object_records)
GET PATCH DELETE
objects/{object_key} /records/{record_id} /
User API Service tier
Retrieve, update, or soft-delete one record.
This read is not paginated. It returns at most 2 rows and does not report a total, so a result of exactly 2 may be truncated.
URL
User API https://sales.mattering.io/api/user/v1/objects/{object_key} /records/{record_id} /
Service tier https://sales.mattering.io/api/internal/objects/{object_key} /records/{record_id} /
Path parameters
Name Type
object_keystr record_iduuid
Query parameters
Responses
200 data and meta envelope
{
"data": {
"record": {
"id": "...",
"object_key": "...",
"display_name": "...",
"data": {
"...": "..."
},
"tags": [
"..."
],
"owner_email": "...",
"space_id": "...",
"is_active": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
}
}
200 data and meta envelope
{
"data": {
"record": {
"id": "...",
"object_key": "...",
"display_name": "...",
"data": {
"...": "..."
},
"tags": [
"..."
],
"owner_email": "...",
"space_id": "...",
"is_active": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
},
"meta": {
"deleted": true
}
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Errors
Status Code
401 unauthorized404 not_found
Example
User API Service tier
curl -X GET "https://sales.mattering.io/api/user/v1/objects/OBJECT_KEY/records/RECORD_ID/?space_id=..." \
-H "Authorization: Bearer $MATTERING_API_KEY" curl -X GET "https://sales.mattering.io/api/internal/objects/OBJECT_KEY/records/RECORD_ID/?space_id=..." \
-H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
-H "X-Internal-Org-Id: $ORG_ID" \
-H "X-Internal-User-Email: you@example.com"
Source: CRMCore/object_api.py (object_api.object_record_detail)