Jobs

Find custom fields for specified account

Gets all custom fields for specified account.

get/jobs-api/v3/accounts/{accountUid}/custom-fields

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Query parameters

searchableOnlyboolean

Get only searchable custom fields.

enabledOnlyboolean

Get only enabled custom fields.

Response

OK

Example response

{
  "data": {
    "fieldUid": "ngahq6dgh4ed",
    "type": "SHORT_TEXT | LONG_TEXT | SELECTBOX | CHECKBOX",
    "enabled": true,
    "required": true,
    "searchable": true,
    "displayToTranslators": true,
    "defaultValue": "default field value",
    "description": "Custom field example"
  }
}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.