Menu

Record fields

1 endpoint in the Mattering Sales API.

GET record-fields/ User APIService tier

``GET record-fields/[?entity=contacts]``: the standard fields a create or update of a business, contact or deal accepts, their aliases, what a create requires and how upsert and bulk identify a record. Anything else in a body is reported back as ``ignored_fields`` and not stored; values with no standard field belong in ``custom_fields`` (list the definitions with ``GET custom-fields/?record_type=``).

URL

  • User APIhttps://sales.mattering.io/api/user/v1/record-fields/
  • Service tierhttps://sales.mattering.io/api/internal/record-fields/

Query parameters

NameDefault
entitynone
qnone

Responses

200 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "entities": {}
  },
  "meta": {
    "custom_fields": {
      "...": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_entity
401unauthorized

Example

curl -X GET "https://sales.mattering.io/api/user/v1/record-fields/?entity=...&q=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: CRMCore/internal_api.py (internal_api.record_fields)

All Sales resources
Start Free Explore our Products