Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
org-config

Return config for a given org

get/v1/org/{orgId}/config

Path parameters

orgIdstring required

Org identifier (either id or slug)

Response

successful operation

idstring required

globally unique id

orgIdstring

parent organization id

hiddenFieldIdsstring[]

set of hidden field ids of an org

smartCurrencyDefaultstring

The default currency to use when currency is unknown and there are no options set in smartCurrencyOptions

requiredJobFieldsstring[]

Org configuration for required job fields

scenarioApprovalChainsobject

Configures which approval chains to use with specific scenario types

isOpenJobRoleApprovalEnabledboolean

Whether to show open job approval on Open Job Profile page

isNotifySubmitterPerStageboolean

Whether to notify the scenario submitter each time an approval stage completes

jobCodeFieldIdsstring[]

The set of field IDs that job codes can be set up to auto-fill

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "hiddenFieldIds": [
    "588f7ee98f138b19220041a7"
  ],
  "builtinCategoryMap": [
    {
      "categoryId": "588f7ee98f138b19220041a7",
      "fieldIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "smartCurrencyDefault": "USD",
  "jobCodeFieldIds": [
    "588f7ee98f138b19220041a7"
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}