List Users | Coactive AI

curl https://api.coactive.ai/api/v1/auth-management/users \
     -H "Authorization: Bearer <token>"

{
  "users": [
    {
      "user_id": "auth0|123",
      "name": "John Doe",
      "created_at": "2024-01-01T00:00:00Z",
      "email": "john@example.com",
      "picture": "https://example.com/avatar.jpg",
      "last_login": "2024-01-02T00:00:00Z",
      "roles": [
        {
          "role_id": "admin"
        }
      ]
    }
  ],
  "meta": {
    "page": {
      "current_page": 1,
      "limit": 1,
      "offset": 1
    },
    "links": {
      "next": "/api/v1/auth-management/users?page=2&limit=10",
      "first": "/api/v1/auth-management/users?page=1&limit=10",
      "last": "/api/v1/auth-management/users?page=10&limit=10"
    },
    "sort": [
      {
        "direction": "asc",
        "field": "created_at"
      }
    ]
  }
}

curl https://api.coactive.ai/api/v1/auth-management/users \
     -H "Authorization: Bearer <token>"

{
  "users": [
    {
      "user_id": "auth0|123",
      "name": "John Doe",
      "created_at": "2024-01-01T00:00:00Z",
      "email": "john@example.com",
      "picture": "https://example.com/avatar.jpg",
      "last_login": "2024-01-02T00:00:00Z",
      "roles": [
        {
          "role_id": "admin"
        }
      ]
    }
  ],
  "meta": {
    "page": {
      "current_page": 1,
      "limit": 1,
      "offset": 1
    },
    "links": {
      "next": "/api/v1/auth-management/users?page=2&limit=10",
      "first": "/api/v1/auth-management/users?page=1&limit=10",
      "last": "/api/v1/auth-management/users?page=10&limit=10"
    },
    "sort": [
      {
        "direction": "asc",
        "field": "created_at"
      }
    ]
  }
}

List users in the organization. This endpoint retrieves a paginated list of users in the organization. The response can be filtered by a search query and optionally include user roles.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystring or nullOptionalformat: "^[a-zA-Z0-9@._\-\s*?]+$"3-50 characters

Search query to match names and emails

user_idslist of strings or nullOptional

List of user IDs to filter by

offsetintegerOptional>=0Defaults to 0

Number of records to skip (for pagination)

limitintegerOptional1-100Defaults to 100

Number of users to return

include_rolesbooleanOptionalDefaults to false

Include user roles in the response

Response

A paginated list of users in the organization

userslist of objects

List of users with partial information

metaobject

Pagination metadata for the response

Errors

422

Unprocessable Entity Error

$	curl https://api.coactive.ai/api/v1/auth-management/users \
>	-H "Authorization: Bearer <token>"

1	{
2	"users": [
3	{
4	"user_id": "auth0\|123",
5	"name": "John Doe",
6	"created_at": "2024-01-01T00:00:00Z",
7	"email": "john@example.com",
8	"picture": "https://example.com/avatar.jpg",
9	"last_login": "2024-01-02T00:00:00Z",
10	"roles": [
11	{
12	"role_id": "admin"
13	}
14	]
15	}
16	],
17	"meta": {
18	"page": {
19	"current_page": 1,
20	"limit": 1,
21	"offset": 1
22	},
23	"links": {
24	"next": "/api/v1/auth-management/users?page=2&limit=10",
25	"first": "/api/v1/auth-management/users?page=1&limit=10",
26	"last": "/api/v1/auth-management/users?page=10&limit=10"
27	},
28	"sort": [
29	{
30	"direction": "asc",
31	"field": "created_at"
32	}
33	]
34	}
35	}