Menu
GET objects/ User APIService tier

Active custom object definitions in the caller's space(s), with fields.

URL

  • User APIhttps://sales.mattering.io/api/user/v1/objects/
  • Service tierhttps://sales.mattering.io/api/internal/objects/

Query parameters

NameDefault
space_idnone

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

StatusCode
401unauthorized
404space_not_found_or_forbidden

Example

curl -X GET "https://sales.mattering.io/api/user/v1/objects/?space_id=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: CRMCore/object_api.py (object_api.objects)

GETPOST objects/{object_key}/records/ User APIService tier

List (GET) or create (POST) records of one custom object.

URL

  • User APIhttps://sales.mattering.io/api/user/v1/objects/{object_key}/records/
  • Service tierhttps://sales.mattering.io/api/internal/objects/{object_key}/records/

Path parameters

NameType
object_keystr

Query parameters

NameDefault
keywordnone
limitnone
offset0
space_idnone

Body keys (JSON)

KeyRequiredDefault
space_idoptional or conditionalnone
tagsoptional or conditionalnone
valuesoptional or conditionalnone

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

StatusCode
401unauthorized

Example

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": "..."
}'

Source: CRMCore/object_api.py (object_api.object_records)

GETPATCHDELETE objects/{object_key}/records/{record_id}/ User APIService 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 APIhttps://sales.mattering.io/api/user/v1/objects/{object_key}/records/{record_id}/
  • Service tierhttps://sales.mattering.io/api/internal/objects/{object_key}/records/{record_id}/

Path parameters

NameType
object_keystr
record_iduuid

Query parameters

NameDefault
space_idnone

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

StatusCode
401unauthorized
404not_found

Example

curl -X GET "https://sales.mattering.io/api/user/v1/objects/OBJECT_KEY/records/RECORD_ID/?space_id=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: CRMCore/object_api.py (object_api.object_record_detail)

All Sales resources
Start Free Explore our Products