List users

GET /api/users

Allows you to get a paginated list of users under your account.

Query parameters

filter string

criteria to filter by
sort string

criteria to sort by
limit string

amount of results per page to return
page string

page number

Responses

200

OK
Hide response attributes Show response attributes object
- data array[object]
  
  Users data
  
  Hide data attributes Show data attributes object
  
  account_id string
  
  Id of the account the user belongs to
  
  email string Required
  
  email of the user to create
  
  id string
  
  ID of the user in the system
  
  name string
  
  Name of the user
  
  role string Required
  
  role of the user to create.
  
  status string
  
  status of the user to create.
- limit number
  
  The number of items per page currently applied
- page number
  
  The number of the page returned
- pages number
  
  The total number of pages matching the current search
- total number
  
  The total number of users matching the query
401

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/users

curl \
 -X GET http://localhost:4000/api/users

Response examples (200)

{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "name": "Test User",
      "role": "customer_read_only",
      "email": "user@test.com",
      "status": "active",
      "account_id": "293f191b-f2e6-4dde-bcab-00b10fdb8cf4"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}

Response examples (200)

{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "name": "Test User",
      "role": "customer_read_only",
      "email": "user@test.com",
      "status": "active",
      "account_id": "293f191b-f2e6-4dde-bcab-00b10fdb8cf4"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}