List managerial key types

GET/api/v1/businesses/{business_id}/managerial-key-mappings/key-types

Return every key type (column) of the Managerial Key Mapping table. The two built-in defaults are always present and flagged is_default: true even before they have been customised.

Operation ID: list_managerial_key_types_api_v1_businesses__business_id__managerial_key_mappings_key_types_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_ManagerialKeyTypesListResponse_

successboolean
messagestring
codestring
dataManagerialKeyTypesListResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/businesses/{business_id}/managerial-key-mappings/key-types

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/{business_id}/managerial-key-mappings/key-types' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'