Custom field definitionsList custom field definitions

List custom field definitions

Requires custom-fields:read. Returns a cursor page. Query predicates are AND-combined; in matches any listed value.

curl -X GET "https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": "example-id-5",
      "key": "segment",
      "dataType": "SINGLE_SELECT",
      "status": "ACTIVE",
      "createdAt": "2026-09-09T06:34:58.430Z",
      "updatedAt": "2026-09-09T06:34:58.430Z",
      "archivedAt": null,
      "label": "Segment",
      "objectType": "contact",
      "nullable": true,
      "required": false,
      "readable": true,
      "writable": false,
      "filterable": true,
      "sortable": false,
      "allowedOperators": [
        "eq",
        "in",
        "isNull"
      ],
      "options": [
        {
          "value": "enterprise",
          "label": "Enterprise"
        }
      ]
    }
  ],
  "nextCursor": null
}
GET
/custom-field-definitions
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Tenant API key beginning with inr_v1_.

Tenant API key beginning with inr_v1_.
query
limitinteger

Page size.

Min: 1 • Max: 100
query
cursorstring

Opaque nextCursor from the preceding page. Preserve filters, q, sort, count and include. Bound to tenant and key scopes; not a snapshot.

query
countstring

Optional complete filtered count.

Options: exact
query
sortstring

Comma-separated fields: createdAt. Prefix - for descending. Default -createdAt; at most two distinct fields. Server appends id as a tie-breaker; nullable values sort last.

query
objectTypestring
Required

Object whose custom definitions are requested.

Options: contact, company
query
statusstring

Definition status.

Options: ACTIVE, ARCHIVED
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Tenant API key beginning with inr_v1_.

Query Parameters

limitinteger

Page size.

cursorstring

Opaque nextCursor from the preceding page. Preserve filters, q, sort, count and include. Bound to tenant and key scopes; not a snapshot.

countstring

Optional complete filtered count.

Allowed values:exact
sortstring

Comma-separated fields: createdAt. Prefix - for descending. Default -createdAt; at most two distinct fields. Server appends id as a tie-breaker; nullable values sort last.

objectTypestring
Required

Object whose custom definitions are requested.

Allowed values:contactcompany
statusstring

Definition status.

Allowed values:ACTIVEARCHIVED

Responses

dataarray
Required
nextCursorstring,null
Required
totalinteger