Skip to content
Convor
Convor Docs
API ReferenceCustom Fields

List localized custom field definitions

Returns every organization-owned custom field definition resolved for the requested locale.

GET/api/custom-fields

Returns every organization-owned custom field definition resolved for the requested locale. Each item includes its immutable key and type, target, required and active state, sort order, localized labels, select options, and full translation lifecycle metadata. This read-only operation is safe to retry.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
custom-fields:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

locale?string

Query parameter. BCP 47 locale or language tag used for localized content.

Length1 <= length <= 35
search?string

Query parameter. Search text.

Lengthlength <= 200
type?string

Query parameter. Resource type.

Lengthlength <= 40
target?string

Query parameter. Value of target.

Lengthlength <= 40
status?string

Query parameter. Status. Allowed values: all, active, inactive.

Default"all"

Value in

  • "all"
  • "active"
  • "inactive"
sortBy?string

Query parameter. Sort by. Allowed values: sortOrder, label, createdAt, type, target, status, sites.

Default"sortOrder"

Value in

  • "sortOrder"
  • "label"
  • "createdAt"
  • "type"
  • "target"
  • "status"
  • "sites"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"asc"

Value in

  • "asc"
  • "desc"
page?integer

Query parameter. One-based page number.

Range1 <= value <= 9007199254740991
limit?integer

Query parameter. Maximum number of records to return.

Range1 <= value <= 100

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "42880ce7-4d1d-469d-a63e-fd75f2c3e96e",      "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",      "projectScope": "all",      "projectIds": [        "11111111-1111-4111-8111-111111111111"      ],      "name": "account_tier",      "type": "select",      "required": false,      "target": "conversation",      "sortOrder": 10,      "active": true,      "label": "Account tier",      "placeholder": "Choose a tier",      "validationMessage": null,      "locale": "en",      "fallbackUsed": false,      "options": [        {          "id": "d879cc4e-11ce-46f3-be45-47d20de0a48f",          "value": "enterprise",          "sortOrder": 0,          "label": "Enterprise",          "locale": "en",          "fallbackUsed": false,          "translations": [            {              "id": "fc094ad3-b971-438f-9884-ae47e3581e4c",              "locale": "en",              "status": "published",              "sourceLocale": null,              "machineTranslatedAt": null,              "reviewedAt": null,              "reviewedBy": null,              "createdAt": "2026-08-03T18:00:00.000Z",              "updatedAt": "2026-08-03T18:00:00.000Z",              "label": "Enterprise"            }          ],          "createdAt": "2026-08-04T10:00:00.000Z",          "updatedAt": "2026-08-04T10:00:00.000Z"        }      ],      "translations": [        {          "id": "3ff47837-a302-466b-925d-6b53d0bbfb37",          "locale": "en",          "status": "published",          "sourceLocale": null,          "machineTranslatedAt": null,          "reviewedAt": null,          "reviewedBy": null,          "createdAt": "2026-08-03T18:00:00.000Z",          "updatedAt": "2026-08-03T18:00:00.000Z",          "label": "Account tier",          "placeholder": "Choose a tier",          "validationMessage": null        }      ],      "createdAt": "2026-08-03T18:00:00.000Z",      "updatedAt": "2026-08-03T18:00:00.000Z"    }  ]}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/custom-fields' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/custom-fields", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete a custom field definition

Permanently deletes a custom field definition, including its localized labels and select options.

Set stable custom field values on a conversation

Merges validated values into a conversation's metadata.customFields object.

On this page

Request examplescurlJavaScript