List users

Lists dashboard users

GET /api/users

Try it

List users

cURL

curl --request GET \
  --url https://{tenant}/api/users \
  --header 'Authorization: Bearer <token>'

200

{
  "pages": 123,
  "users": [
    {
      "email_address": "[e-mail]",
      "first_name": "itachi",
      "last_name": "sasuke",
      "user_permissions": {},
      "access_key": "d7ebef749e4348cb67fec3cfc81f0a50",
      "active": true,
      "api_model": {},
      "created_at": "2024-05-19T08:23:29.034+03:00",
      "group_id": "5e9d9544a1dcd60001d0ed20",
      "id": "66498cd1e2fcd1000184ecb5",
      "last_login_date": "2024-05-19T08:42:22.659839+03:00",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "password_updated": "2024-05-19T08:23:29.146+03:00"
    }
  ]
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

p · integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

Response

200

application/json

Users retrieved successfully.

pages · integer

users · object[] | null

Show child attributes

users. email_address · string · required

Example:

"[e-mail]"

users. first_name · string · required

Example:

"itachi"

users. last_name · string · required

Example:

"sasuke"

users. user_permissions · object · required

Show child attributes

users.user_permissions. {key} · string

users. access_key · string

Example:

"d7ebef749e4348cb67fec3cfc81f0a50"

users. active · boolean

Example:

true

users. api_model · object

users. created_at · string<date-time>

Example:

"2024-05-19T08:23:29.034+03:00"

users. group_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

users. id · string

Example:

"66498cd1e2fcd1000184ecb5"

users. last_login_date · string<date-time>

Example:

"2024-05-19T08:42:22.659839+03:00"

users. org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

users. password_max_days · integer

Example:

0

users. password_updated · string<date-time>

Example:

"2024-05-19T08:23:29.146+03:00"