API reference

Users

Create and read end-users scoped to your application. Every user belongs to your app and can own its own entities. A user may also create further users by passing their id as created_by_user_id — so you can build a hierarchy of users under one application. Requires an access token.

POST/oauth/usersAccess token

Create a user

Create an end-user that belongs to your application. Omit created_by_user_id and the user is attributed to the application owner (the default). To let one of your existing users create another user, pass that user's id as created_by_user_id — it must be a user of this same application. The response returns the new user_id, which you can then use as user_id when creating entities for that user.

Request body example

{
  "email": "user@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+971500000000",
  "created_by_user_id": ""
}

GET/oauth/usersAccess token

List users

Return all users connected to your application. The application is resolved automatically from your access token — no parameters required.

GET/oauth/users/{user_id}Access token

Get a user

Fetch a user created by your application.

PreviousIdentity NextEntities