/employee_fields

Returns a collection of your account employee_fields. Required scope: r_account.

get/employee_fields

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/employee_fields
  • Auth
    API key in header Authorization

Path parameters

subdomainstring required

The account subdomain

Query parameters

member_idstring

Optional member id that can be derived from GET /members endpoint

Response

200

idstring
account_idstring
labelstring
hintunknown
typestring
editable_bystring
approvable_bystring
viewable_bystring
keep_historyboolean
is_multipleboolean

Example response

[
  {
    "id": "firstname",
    "account_id": "3da58cc2",
    "label": "First name",
    "type": "text",
    "editable_by": "admin",
    "approvable_by": "admin",
    "viewable_by": "all"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.