GET /api/v2/users
List users

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Examples

// Successful request
GET /api/v2/users
200
{
  "users": [
    {
      "id": 114,
      "email": "admin-user-111@example.com",
      "last_login": "2023-11-27T09:43:41.634Z",
      "company": null,
      "first_name": null,
      "last_name": null,
      "favorites": [],
      "about": null,
      "job_title": null,
      "phone_number": null,
      "user_role": {
        "id": 1,
        "name": "admin",
        "created_at": "2023-11-27T09:42:35.117Z",
        "updated_at": "2023-11-27T09:42:35.294Z",
        "description": "System default"
      },
      "user_groups": [],
      "terms_agreed": false,
      "sso": false,
      "avatar_url": null
    }
  ]
}

// Successful request
GET /api/v2/users
200
{
  "users": [
    {
      "id": 117,
      "email": "admin-user-112@example.com",
      "last_login": "2023-11-27T09:43:41.775Z",
      "company": null,
      "first_name": null,
      "last_name": null,
      "favorites": [],
      "about": null,
      "job_title": null,
      "phone_number": null,
      "user_role": {
        "id": 1,
        "name": "admin",
        "created_at": "2023-11-27T09:42:35.117Z",
        "updated_at": "2023-11-27T09:42:35.294Z",
        "description": "System default"
      },
      "user_groups": [],
      "terms_agreed": false,
      "sso": false,
      "avatar_url": null
    },
    {
      "id": 115,
      "email": "default-user-1@example.com",
      "last_login": null,
      "company": null,
      "first_name": null,
      "last_name": null,
      "favorites": [],
      "about": null,
      "job_title": null,
      "phone_number": null,
      "user_role": {
        "id": 2,
        "name": "default",
        "created_at": "2023-11-27T09:42:35.298Z",
        "updated_at": "2023-11-27T09:42:35.424Z",
        "description": "System default"
      },
      "user_groups": [],
      "terms_agreed": false,
      "sso": false,
      "avatar_url": null
    },
    {
      "id": 116,
      "email": "guest-user-1@example.com",
      "last_login": null,
      "company": null,
      "first_name": null,
      "last_name": null,
      "favorites": [],
      "about": null,
      "job_title": null,
      "phone_number": null,
      "user_role": {
        "id": 3,
        "name": "guest",
        "created_at": "2023-11-27T09:42:35.427Z",
        "updated_at": "2023-11-27T09:42:35.553Z",
        "description": "System default"
      },
      "user_groups": [],
      "terms_agreed": false,
      "sso": false,
      "avatar_url": null
    }
  ]
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters