POST /profile/get
Get Profile
Get profile information using the canonical shared profile operation.
Request Body (GetProfileApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | UUID of the profile to retrieve |
target_profile_id | string | No | Legacy alias for profile UUID |
draft_id | string | No | UUID of the draft to load |
snapshot_key | string | No | Cache snapshot key for consistent reads across related requests |
names | app__infra__profile__types__SectionFilter | No | Filter options for names section |
emails | app__infra__profile__types__SectionFilter | No | Filter options for emails section |
flags | app__infra__profile__types__SectionFilter | No | Filter options for flags section |
departments | app__infra__profile__types__SectionFilter | No | Filter options for departments section |
roles | app__infra__profile__types__SectionFilter | No | Filter options for roles section |
Response (GetProfileApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
actor_name | string | No | Display name of the acting user |
profile_exists | boolean | No | Whether the profile exists |
can_edit | boolean | No | Whether the actor can edit this profile |
disabled_reason | string | No | Reason editing is disabled, if any |
group_id | string | No | Group UUID for draft collaboration |
draft_name | string | No | Immutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. |
profile_id | string | No | UUID of the profile |
show_ai_generate | boolean | No | Whether to show AI generate anywhere |
basic_show_ai_generate | boolean | No | Whether to show AI generate on the basic step |
contact_show_ai_generate | boolean | No | Whether to show AI generate on the contact step |
pending_ids | string[] | No | Pending resource identifiers when available |
role_options | string[] | No | Role names the actor can assign |
names | ProfileNameResource[] | No | Name resources |
emails | ProfileEmailResource[] | No | Email resources |
flags | ProfileFlagResource[] | No | Flag resources (one per flags_resource row, value=true/false) |
departments | ProfileDepartmentResource[] | No | Department resources |
roles | ProfileRoleResource[] | No | Role resources |
permissions | ProfilePermissionResource[] | No | Permission catalog for the role editor |
request_limits | ProfileRequestLimitResource[] | No | Request-limit catalog for the role editor |
Last updated on