GET: the fields assigned to a record type. POST: create a field, or attach one from the org library with ``library_id``.
URL
User APIhttps://sales.mattering.io/api/user/v1/custom-fields/
Service tierhttps://sales.mattering.io/api/internal/custom-fields/
Query parameters
Name
Default
pipe_id
none
record_type
none
Body keys (JSON)
Key
Required
Default
field_type
optional or conditional
none
library_id
optional or conditional
none
name
optional or conditional
none
pipe_id
optional or conditional
none
record_type
optional 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.
Responses
200data and meta envelope, legacy keys repeated beside data
The org's shared field library, each flagged with whether it is already assigned to ``record_type`` (and ``pipe_id`` for deals).
Each row's field_type is the Sales type: the one attaching the row by library_id produces, and one a create accepts, so what is read can be sent. library_type is the platform's canonical name for the same definition (TEXT_SMALL, DROPDOWN ...). Where the platform type has no Sales equivalent (TAGS, RATING, LOCATION) attach stores it as field_type and type_note says so. To add a row that already exists, attach it with library_id alone; no type is needed.
URL
User APIhttps://sales.mattering.io/api/user/v1/custom-fields/library/
Service tierhttps://sales.mattering.io/api/internal/custom-fields/library/
Query parameters
Name
Default
pipe_id
none
record_type
none
Responses
200data and meta envelope, legacy keys repeated beside data
{
"data": {
"library": [
{
"library_id": "...",
"name": "...",
"field_type": "...",
"library_type": "...",
"description": "...",
"assigned": true
}
]
},
"meta": {
"how_to_add": "Attach a row that is not assigned yet with POST custom-fields/ and its library_id; no name or type is needed. Create a new field only when no row here matches."
}
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Errors
Status
Code
401
unauthorized
403
org_unresolved
503
library_unavailable
Example
curl -X GET "https://sales.mattering.io/api/user/v1/custom-fields/library/?pipe_id=...&record_type=..." \
-H "Authorization: Bearer $MATTERING_API_KEY"
GET one field, PATCH its definition (type is locked), DELETE to remove it from the record type (library definition and stored values are kept).
URL
User APIhttps://sales.mattering.io/api/user/v1/custom-fields/{record_type}/{field_id}/
Service tierhttps://sales.mattering.io/api/internal/custom-fields/{record_type}/{field_id}/
Path parameters
Name
Type
record_type
str
field_id
uuid
Body keys (JSON)
Key
Required
Default
field_type
optional 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.
Responses
200data and meta envelope, legacy keys repeated beside data
We use strictly necessary cookies to run this site. With your permission we also use analytics cookies
(Google Analytics and our own visit tracking) to see which pages work. Read the
Cookie notice.