Skip to Content

POST /department/get

Get Department

Get department information using the canonical shared department operation.

Request Body (GetDepartmentApiRequest)

FieldTypeRequiredDescription
idstringNoDepartment UUID to retrieve
department_idstringNoLegacy department UUID to retrieve
draft_idstringNoUUID of the draft to load
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__department__types__SectionFilterNoFilter options for names section
descriptionsapp__infra__department__types__SectionFilterNoFilter options for descriptions section
flagsapp__infra__department__types__SectionFilterNoFilter options for flags section
settingsapp__infra__department__types__SectionFilterNoFilter options for settings section

Response (GetDepartmentApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the acting user
department_existsbooleanNoWhether the department exists
can_editbooleanNoWhether the actor can edit this department
disabled_reasonstringNoReason editing is disabled, if any
group_idstringNoGroup UUID for draft collaboration
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches.
show_ai_generatebooleanNoWhether to show AI generate anywhere
basic_show_ai_generatebooleanNoWhether to show AI generate for basic sections
pending_idsstring[]NoPending resource identifiers when available
namesDepartmentNameResource[]NoName resources
descriptionsDepartmentDescriptionResource[]NoDescription resources
flagsDepartmentFlagResource[]NoFlag resources (one per flags_resource row, value=true/false)
settingsDepartmentSettingResource[]NoSetting resources
Last updated on