List users
Changed onList all users in your organization.
Request
- Base URLhttps://api.nullplatform.com
- URLhttps://api.nullplatform.com/user
- AuthHTTP bearer
Query parameters
Filter users by the ID of the organization.
Filter users by their email address.
Filter users by their first name.
Filter users by their last name.
Filter users by their status. Multiple values can be provided, separated by commas.
Filter users by their ID. Multiple values can be provided, separated by commas.
Filter users by user type.
Number of items to skip. Defaults to 0.
Maximum number of items to return per page. Maximum is 200.
Response
The list of users matching the query.
Example response
{
"results": [
{
"id": 123456,
"email": "alex.mgr@crypto-inc.com",
"first_name": "Alex",
"last_name": "Doe",
"organization_id": 1234,
"status": "active",
"avatar": "https://my-avatar-url.com",
"type": "person",
"provider": "cognito",
"nrn": "organization=123",
"send_invite": true,
"metadata": {
"key": "value"
}
}
]
}Changes
- breaking
the response property
became optional for the status - breaking
the response property
became optional for the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
response property
messagedeprecated - info
response property
messagedeprecated - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking