List users
Retrieve all users matching the provided filters.
Query Parameters
Filter users by exact email address.
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Response
application/json
Response
A list response for users
The user’s full profile
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
Get user
Retrieve the profile of the specified user.
Path Parameters
The user ID
Example:usr_abc123
Response
application/json
Response
A single user profile response
User
The user’s full profile
Unique identifier for the user
Example:usr_abc123
The user’s first name
Example:Jane
The user’s last name
Example:Doe
URL to the user’s profile picture
Example:https://cdn.insomnia.rest/avatars/usr_abc123.jpg
The email address
Example:jane.doe@example.com
An email address associated with a user
Show Child Parameters
Indicates the user was provisioned externally (e.g., via SCIM). When true, profile fields (first_name, last_name, email, emails, picture) cannot be updated by the user.
Example:false
Whether end-to-end encryption is enabled for this user
Example:false
The date and time the user account was created
Example:2024-01-15T08:30:00Z
Authentication
Path Parameters
Update current user
Update the profile of the currently authenticated user.
All fields are optional - only provided fields will be updated.
Body
application/json
Body
UserUpdate
Fields that can be updated on a user profile
The user’s first name
Example:Jane
The user’s last name
Example:Doe
Response
application/json
Response
A single user profile response
User
The user’s full profile
Unique identifier for the user
Example:usr_abc123
The user’s first name
Example:Jane
The user’s last name
Example:Doe
URL to the user’s profile picture
Example:https://cdn.insomnia.rest/avatars/usr_abc123.jpg
The email address
Example:jane.doe@example.com
An email address associated with a user
Show Child Parameters
Indicates the user was provisioned externally (e.g., via SCIM). When true, profile fields (first_name, last_name, email, emails, picture) cannot be updated by the user.
Example:false
Whether end-to-end encryption is enabled for this user
Example:false
The date and time the user account was created
Example:2024-01-15T08:30:00Z
Authentication
Body
Start adding a user email address
Sends a verification code to the email address provided (if available).
Body
application/json
Body
Request to send a verification code to a user email address
The email address
Example:jane.doe@example.com
Response
application/json
Response
Verification code sent successfully response
The email address
Example:jane.doe@example.com
Authentication
Body
Verify an email address
Verify an email address for the current user.
Path Parameters
The email address
Example:jane.doe@example.com
Body
application/json
Body
Request to verify a user email address
Example:1W34Q6
Response
Response
Email verified successfully