Notion Users API
Users represent people or bots in a Notion workspace. Person users are human members of the workspace, while bot users represent API integrations. Use these endpoints to list users, retrieve specific users, or get information about the current bot integration.
Notion Users API is one of 6 APIs that Notion publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, authentication docs, a getting-started guide, and 3 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2022-06-28.
Requests are made against a single base URL, https://api.notion.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Notion Users API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Notion API uses bearer token authentication. Obtain an integration token from https://www.notion.so/my-integrations. Pass the token in the Authorization header…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Users represent people or bots in a Notion workspace. Person users are human members of the workspace, while bot users represent API integrations. Use these endpoints to list user…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (7 properties), PaginatedList (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Notion 5
Other APIs Notion publishes across the network.