List custom fields
Header Parameters
Query Parameters
Page number, starting at 1.
Results per page. Default 25, maximum 100.
true or false (also 1/0). Anything else is a 400.
Narrow to fields asked per item or per request. An unknown value is a 400 listing the valid ones.
ITEMREQUESTNarrow by field type. An unknown value is a 400 listing the valid ones.
BOOLEANTEXTPRICESELECTDATESort key, prefixed with - for descending. Default order, the position in the form, which is also what the in-app endpoint returns. createdAt sorts on the creation time even though the shape does not expose it. An unknown key is a 400 listing the valid ones. A stable -id tiebreaker is always appended, so paging cannot repeat or skip a row.
order-ordername-namecreatedAt-createdAtComma-separated allow-list of top-level fields to return, e.g. ?fields=id,name. Narrows the response only; it cannot widen it, and ?expand= does nothing on this API.
Comma-separated list of top-level fields to leave out, e.g. ?omit=children.
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Response
Paginated list of custom-field definitions.
Response Attributes
Total matching records across all pages.
Total pages. 0 when there are no results.
The page this response contains.
Show child attributes
A query parameter was invalid or unknown. attr names it.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError