Notion: Users schemas
2 Notion schemas with complete fields and constraints.
← Users operations · All schemas
Retrieve a user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: allowed |
$ (anyOf 1).agent_id | string | Optional | The ID of the Custom Agent this bot acts for. Only present when the user is a Custom Agent's bot. Format: uuid |
$ (anyOf 1).avatar_url | JSON | Required within parent | The avatar URL of the user. |
$ (anyOf 1).avatar_url (anyOf 1) | string | Alternative | |
$ (anyOf 1).avatar_url (anyOf 2) | null | Alternative | |
$ (anyOf 1).id | string | Required within parent | The ID of the user. Format: uuid |
$ (anyOf 1).name | JSON | Required within parent | The name of the user. |
$ (anyOf 1).name (anyOf 1) | string | Alternative | |
$ (anyOf 1).name (anyOf 2) | null | Alternative | |
$ (anyOf 1).object | string | Required within parent | The user object type name. Must equal: user |
$ (anyOf 1).person | object | Required within parent | Details about the person, when the `type` of the user is `person`. Additional keys: allowed |
$ (anyOf 1).person.email | string | Optional | The email of the person. |
$ (anyOf 1).person.email_verified | boolean | Optional | Whether the person's email is verified. |
$ (anyOf 1).type | string | Required within parent | Indicates this user is a person. Must equal: person |
$ (anyOf 2) | object | Alternative | Additional keys: allowed |
$ (anyOf 2).agent_id | string | Optional | The ID of the Custom Agent this bot acts for. Only present when the user is a Custom Agent's bot. Format: uuid |
$ (anyOf 2).avatar_url | JSON | Required within parent | The avatar URL of the user. |
$ (anyOf 2).avatar_url (anyOf 1) | string | Alternative | |
$ (anyOf 2).avatar_url (anyOf 2) | null | Alternative | |
$ (anyOf 2).id | string | Required within parent | The ID of the user. Format: uuid |
$ (anyOf 2).name | JSON | Required within parent | The name of the user. |
$ (anyOf 2).name (anyOf 1) | string | Alternative | |
$ (anyOf 2).name (anyOf 2) | null | Alternative | |
$ (anyOf 2).object | string | Required within parent | The user object type name. Must equal: user |
$ (anyOf 2).bot | JSON | Required within parent | Details about the bot, when the `type` of the user is `bot`. |
$ (anyOf 2).bot (anyOf 1) | Model | Alternative | Expand List views — response body — view |
$ (anyOf 2).bot (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body — object user, type bot bot owner, workspace id, workspace limits, workspace name |
$ (anyOf 2).type | string | Required within parent | Indicates this user is a bot. Must equal: bot |
Referenced models: List views — response body — view, Retrieve a user — response body — object user, type bot bot owner, workspace id, workspace limits, workspace name
Retrieve a user — response body — object user, type bot bot owner, workspace id, workspace limits, workspace name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
owner | JSON | Required within parent | Details about the owner of the bot. |
owner (anyOf 1) | object | Alternative | Additional keys: allowed |
owner (anyOf 1).type | string | Required within parent | Always `user` Must equal: user |
owner (anyOf 1).user | JSON | Required within parent | Details about the owner of the bot, when the `type` of the owner is `user`. This means the bot is for a integration. |
owner (anyOf 1).user (anyOf 1) | object | Alternative | Additional keys: allowed |
owner (anyOf 1).user (anyOf 1).avatar_url | JSON | Required within parent | The avatar URL of the user. |
owner (anyOf 1).user (anyOf 1).avatar_url (anyOf 1) | string | Alternative | |
owner (anyOf 1).user (anyOf 1).avatar_url (anyOf 2) | null | Alternative | |
owner (anyOf 1).user (anyOf 1).id | string | Required within parent | The ID of the user. Format: uuid |
owner (anyOf 1).user (anyOf 1).name | JSON | Required within parent | The name of the user. |
owner (anyOf 1).user (anyOf 1).name (anyOf 1) | string | Alternative | |
owner (anyOf 1).user (anyOf 1).name (anyOf 2) | null | Alternative | |
owner (anyOf 1).user (anyOf 1).object | string | Required within parent | The user object type name. Must equal: user |
owner (anyOf 1).user (anyOf 1).person | object | Required within parent | The person info of the user. Additional keys: allowed |
owner (anyOf 1).user (anyOf 1).person.email | string | Optional | The email of the person. |
owner (anyOf 1).user (anyOf 1).person.email_verified | boolean | Optional | Whether the person's email is verified. |
owner (anyOf 1).user (anyOf 1).type | string | Required within parent | The type of the user. Must equal: person |
owner (anyOf 1).user (anyOf 2) | Model | Alternative | Expand Update page — response body — object page created by |
owner (anyOf 2) | object | Alternative | Additional keys: allowed |
owner (anyOf 2).type | string | Required within parent | Always `workspace` Must equal: workspace |
owner (anyOf 2).workspace | boolean | Required within parent | Details about the owner of the bot, when the `type` of the owner is `workspace`. This means the bot is for an internal integration. Must equal: true |
workspace_id | string | Required within parent | The ID of the bot's workspace. |
workspace_limits | object | Required within parent | Limits and restrictions that apply to the bot's workspace Additional keys: allowed |
workspace_limits.max_file_upload_size_in_bytes | JSON | Required within parent | |
workspace_limits.max_file_upload_size_in_bytes (anyOf 1) | integer | Alternative | The maximum allowable size of a file upload, in bytes Minimum: 0 |
workspace_limits.max_file_upload_size_in_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workspace_name | JSON | Required within parent | The name of the bot's workspace. |
workspace_name (anyOf 1) | string | Alternative | |
workspace_name (anyOf 2) | null | Alternative |
Referenced models: Update page — response body — object page created by