Skip to content

reference:users

Axel Boberg edited this page May 24, 2019 · 5 revisions

GET /api/v1/users

Get a list of all users

Query parameters

Name Required  Value
limit  No A number limiting the number of returned results. Must be less than 200. Defaults to 25.
offset  No A number offsetting the returned results. Defaults to 0.

POST /api/v1/users

Create one or multiple new users

Headers

Name Required  Value
Content-Type  Yes application/json

Body

The body can be either a single object or an array of objects of the following format:

[
 {
  "first_name": "John", // A string, max 50 characters long
  "last_name": "Doe", // A string, max 50 characters long
  "credentials": [
   {
    "type": "email", // One of ["email", "phone"]
    "value": "[email protected]", // A string, max 50 characters long
    "is_primary": false // A boolean indicating whether or not the credential can be used for authentication
   }
  ]
 }
]

GET /api/v1/users/:id

Get a specific user