Skip to content

Notion: Users schemas

2 Notion schemas with complete fields and constraints.

← Users operations · All schemas

Retrieve a user — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: allowed
$ (anyOf 1).agent_idstringOptionalThe 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_urlJSONRequired within parentThe avatar URL of the user.
$ (anyOf 1).avatar_url (anyOf 1)stringAlternative
$ (anyOf 1).avatar_url (anyOf 2)nullAlternative
$ (anyOf 1).idstringRequired within parentThe ID of the user.
Format: uuid
$ (anyOf 1).nameJSONRequired within parentThe name of the user.
$ (anyOf 1).name (anyOf 1)stringAlternative
$ (anyOf 1).name (anyOf 2)nullAlternative
$ (anyOf 1).objectstringRequired within parentThe user object type name.
Must equal: user
$ (anyOf 1).personobjectRequired within parentDetails about the person, when the `type` of the user is `person`.
Additional keys: allowed
$ (anyOf 1).person.emailstringOptionalThe email of the person.
$ (anyOf 1).person.email_verifiedbooleanOptionalWhether the person's email is verified.
$ (anyOf 1).typestringRequired within parentIndicates this user is a person.
Must equal: person
$ (anyOf 2)objectAlternativeAdditional keys: allowed
$ (anyOf 2).agent_idstringOptionalThe 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_urlJSONRequired within parentThe avatar URL of the user.
$ (anyOf 2).avatar_url (anyOf 1)stringAlternative
$ (anyOf 2).avatar_url (anyOf 2)nullAlternative
$ (anyOf 2).idstringRequired within parentThe ID of the user.
Format: uuid
$ (anyOf 2).nameJSONRequired within parentThe name of the user.
$ (anyOf 2).name (anyOf 1)stringAlternative
$ (anyOf 2).name (anyOf 2)nullAlternative
$ (anyOf 2).objectstringRequired within parentThe user object type name.
Must equal: user
$ (anyOf 2).botJSONRequired within parentDetails about the bot, when the `type` of the user is `bot`.
$ (anyOf 2).bot (anyOf 1)ModelAlternativeExpand List views — response body — view
$ (anyOf 2).bot (anyOf 2)ModelAlternativeExpand Retrieve a user — response body — object user, type bot bot owner, workspace id, workspace limits, workspace name
$ (anyOf 2).typestringRequired within parentIndicates 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
ownerJSONRequired within parentDetails about the owner of the bot.
owner (anyOf 1)objectAlternativeAdditional keys: allowed
owner (anyOf 1).typestringRequired within parentAlways `user`
Must equal: user
owner (anyOf 1).userJSONRequired within parentDetails 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)objectAlternativeAdditional keys: allowed
owner (anyOf 1).user (anyOf 1).avatar_urlJSONRequired within parentThe avatar URL of the user.
owner (anyOf 1).user (anyOf 1).avatar_url (anyOf 1)stringAlternative
owner (anyOf 1).user (anyOf 1).avatar_url (anyOf 2)nullAlternative
owner (anyOf 1).user (anyOf 1).idstringRequired within parentThe ID of the user.
Format: uuid
owner (anyOf 1).user (anyOf 1).nameJSONRequired within parentThe name of the user.
owner (anyOf 1).user (anyOf 1).name (anyOf 1)stringAlternative
owner (anyOf 1).user (anyOf 1).name (anyOf 2)nullAlternative
owner (anyOf 1).user (anyOf 1).objectstringRequired within parentThe user object type name.
Must equal: user
owner (anyOf 1).user (anyOf 1).personobjectRequired within parentThe person info of the user.
Additional keys: allowed
owner (anyOf 1).user (anyOf 1).person.emailstringOptionalThe email of the person.
owner (anyOf 1).user (anyOf 1).person.email_verifiedbooleanOptionalWhether the person's email is verified.
owner (anyOf 1).user (anyOf 1).typestringRequired within parentThe type of the user.
Must equal: person
owner (anyOf 1).user (anyOf 2)ModelAlternativeExpand Update page — response body — object page created by
owner (anyOf 2)objectAlternativeAdditional keys: allowed
owner (anyOf 2).typestringRequired within parentAlways `workspace`
Must equal: workspace
owner (anyOf 2).workspacebooleanRequired within parentDetails 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_idstringRequired within parentThe ID of the bot's workspace.
workspace_limitsobjectRequired within parentLimits and restrictions that apply to the bot's workspace
Additional keys: allowed
workspace_limits.max_file_upload_size_in_bytesJSONRequired within parent
workspace_limits.max_file_upload_size_in_bytes (anyOf 1)integerAlternativeThe maximum allowable size of a file upload, in bytes
Minimum: 0
workspace_limits.max_file_upload_size_in_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workspace_nameJSONRequired within parentThe name of the bot's workspace.
workspace_name (anyOf 1)stringAlternative
workspace_name (anyOf 2)nullAlternative

Referenced models: Update page — response body — object page created by

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.