SMsmartling
Jobs

Find custom fields for specified account

Changed on

Gets all custom fields for specified account.

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

Request

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": "7a1f5c2e-3b9d-4e8a-9c64-2d0b8f1e5a37",
    "type": "SHORT_TEXT | LONG_TEXT | SELECTBOX | CHECKBOX",
    "fieldName": true,
    "enabled": true,
    "required": true,
    "searchable": true,
    "displayToTranslators": true,
    "options": [
      "option1"
    ],
    "defaultValue": "default field value",
    "description": "Custom field example"
  }
}

Changes

  • 2cd7a8215799Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

  • ae422098d9c5Revision changes
    • info

      endpoint added