List Users

GET https://api.coactive.ai/api/v1/auth-management/users

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

• Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Query parameters

• query (string, optional, nullable) — Search query to match names and emails
• user_ids (list of string, optional, nullable) — List of user IDs to filter by
• offset (integer, optional, default: 0) — Number of records to skip (for pagination)
• limit (integer, optional, default: 100) — Number of users to return
• include_roles (boolean, optional, default: false) — Include user roles in the response

Response

200

A paginated list of users in the organization

• users (list of object, required) — List of users with partial information
  • user_id (string, required) — Unique identifier for the user
  • name (string, required) — Display name of the user
  • created_at (string, required) — Timestamp when the user was created
  • email (string, optional, nullable) — Email address of the user
  • picture (string, optional, nullable) — URL to the user’s profile picture
  • last_login (string, optional, nullable) — Timestamp of the user’s last login
  • roles (list of object, optional, nullable) — Optional list of roles assigned to the user
    • role_id (string, required) — Name of the role (e.g., ‘admin’, ‘editor’, ‘viewer’)
    • resource (string, optional, nullable) — Optional resource type the role applies to (e.g., ‘dataset’)
    • resource_instance (string, optional, nullable) — Optional resource instance ID the role applies to
• meta (object, required) — Pagination metadata for the response
  • page (object, required) — Current page number (1-indexed)
    • current_page (integer, required) — Current page number (1-indexed)
    • limit (integer, required) — Number of items per page
    • offset (integer, required) — Offset of the first item in the current page
    • last_page (integer, optional, nullable) — Last page number (if total is known)
    • total (integer, optional, nullable) — Total number of items across all pages
  • links (object, required) — Links to the previous, next, first, and last pages
    • prev (string, optional, nullable) — URL for the previous page
    • next (string, optional, nullable) — URL for the next page
    • first (string, optional, nullable) — URL for the first page
    • last (string, optional, nullable) — URL for the last page
  • sort (list of object, required) — Sort order for the response
    • direction (enum, required) — Sort direction (ascending or descending)
      • Allowed values: asc, desc
    • field (string, required) — Field name to sort by

Errors

422 Unprocessable Entity Error

Validation Error

• detail (list of object, optional)
  • loc (list of string or integer, required)
  • msg (string, required)
  • type (string, required)

Examples

Response

{
  "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"
      }
    ]
  }
}

SDK Code

import requests

url = "https://api.coactive.ai/api/v1/auth-management/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

const url = 'https://api.coactive.ai/api/v1/auth-management/users';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.coactive.ai/api/v1/auth-management/users"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coactive.ai/api/v1/auth-management/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coactive.ai/api/v1/auth-management/users")
  .header("Authorization", "Bearer <token>")
  .asString();

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coactive.ai/api/v1/auth-management/users', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.coactive.ai/api/v1/auth-management/users");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);

import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coactive.ai/api/v1/auth-management/users")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()