{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/managerial-key-mappings/key-types","version":"1.0.0","description":"List managerial key types"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/managerial-key-mappings/key-types":{"get":{"tags":["managerial-key-mappings"],"summary":"List managerial key types","description":"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.","operationId":"list_managerial_key_types_api_v1_businesses__business_id__managerial_key_mappings_key_types_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ManagerialKeyTypesListResponse_"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ManagerialKeyTypeResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Definition row id. For an implicit default that has not been customised yet this equals ``key``."},"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"sort_order":{"type":"integer","title":"Sort Order"},"is_active":{"type":"boolean","title":"Is Active"},"is_default":{"type":"boolean","title":"Is Default","description":"True for the built-in defaults every business has.","default":false},"mapping_count":{"type":"integer","title":"Mapping Count","description":"Number of ledgers mapped under this key type.","default":0}},"type":"object","required":["id","key","label","sort_order","is_active"],"title":"ManagerialKeyTypeResponse","description":"One key type (a column of the mapping table)."},"ManagerialKeyTypesListResponse":{"properties":{"key_types":{"items":{"$ref":"#/components/schemas/ManagerialKeyTypeResponse"},"type":"array","title":"Key Types"}},"type":"object","required":["key_types"],"title":"ManagerialKeyTypesListResponse"},"SuccessEnvelope_ManagerialKeyTypesListResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/ManagerialKeyTypesListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ManagerialKeyTypesListResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}