The User object represents a user in a Notion workspace. Users include full workspace members, and bots. Guests are not included. You can find more information about members and guests in this guide.
Provisioning users and groups using SCIM
The SCIM API is available for workspaces in Notion's Enterprise Plan. Learn more about using SCIM with Notion.
Setting up single sign-on (SSO) with Notion
Single sign-on (SSO) can be configured for workspaces in Notion's Enterprise Plan. Learn more about SSO with Notion.
Where user objects appear in the API
User objects appear in the API in nearly all objects returned by the API, including:
- Block object under
created_by
andlast_edited_by
. - Page object under
created_by
andlast_edited_by
and inpeople
property items. - Database object under
created_by
andlast_edited_by
. - Rich text object, as user mentions.
- Property object when the property is a
people
property.
User objects will always contain object
and id
keys, as described below. The remaining properties may appear if the user is being rendered in a rich text or page property context, and the bot has the correct capabilities to access those properties. For more about capabilities, see the Capabilities guide and the Authorization guide.
All users
These fields are shared by all users, including people and bots. Fields marked with * are always present.
Property | Updatable | Type | Description | Example value |
---|---|---|---|---|
| Display-only |
| Always "user" |
|
| Display-only |
| Unique identifier for this user. |
|
| Display-only |
| Type of the user. Possible values are |
|
| Display-only |
| User's name, as displayed in Notion. |
|
| Display-only |
| Chosen avatar image. |
|
People
User objects that represent people have the type
property set to "person"
. These objects also have the following properties:
Property | Updatable | Type | Description | Example value |
---|---|---|---|---|
| Display-only |
| Properties only present for non-bot users. | |
| Display-only |
| Email address of person. This is only present if an integration has user capabilities that allow access to email addresses. |
Bots
User objects that represent bots have the type
property set to "bot"
. These objects also have the following properties:
Property | Updatable | Type | Description | Example value |
---|---|---|---|---|
| Display-only |
| Properties only present for bot users. If viewing your own bot with | |
| Information about who owns this bot. | |||
| Display-only |
| The type of owner - either |
When viewing information about "your own" bot specifically - that is, the bot tied to the API token being used to call the API - the bot
property will contain the following additional fields:
Property | Updatable | Type | Description | Example value |
---|---|---|---|---|
| Display-only |
| Information about who owns this bot. | |
| Display-only |
| The type of owner - either |
|
| Display-only |
| Always |
|
| Display-only |
| A user object describing who owns this bot. Currently only |
|