v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Users

List all users

get/users

Query parameters

fieldsstring

Selection of fields, separated by space. If fields not be chosen response will be return with all fields. The selected fields from the users table will be returned inside the response

skipnumber

Pagination

limitnumber

Pagination, max: 200

sortstring

Sorting

qstring

Search query string. Searches in fullName, emails, phones

Response

Successful response

countnumber required

fieldsstring required

sortstring required

skipnumber required

limitnumber required

Example response

{
  "count": 42,
  "fields": "fullName",
  "sort": "fullName",
  "skip": 20,
  "limit": 10,
  "results": [
    {
      "_id": "611d02b7c9c54b01736ae01d",
      "accountId": "611cf837c9c54b01736ae01c",
      "email": "example@email.com",
      "emails": [
        "example@email.com"
      ],
      "firstName": "John",
      "lastName": "Boe",
      "fullName": "John Boe",
      "title": "CTO",
      "timezone": "Europe/Zurich",
      "picture": {
        "thumbnail": "https://thumbnail.url.com",
        "regular": "https://regular.url.com",
        "large": "https://large.url.com"
      },
      "tags": [
        "tag1"
      ],
      "settings": {
        "notifications": {
          "subscriptions": [
            {
              "type": "PAYMENT",
              "name": "FAILED",
              "targets": [
                "DASHBOARD"
              ]
            }
          ]
        }
      }
    }
  ]
}