Get Organization Users

curl --request GET \
  --url https://asteragents.com/api/admin/getUsersInOrg \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://asteragents.com/api/admin/getUsersInOrg', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://asteragents.com/api/admin/getUsersInOrg",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://asteragents.com/api/admin/getUsersInOrg"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://asteragents.com/api/admin/getUsersInOrg")

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

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

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

{
  "400": {},
  "401": {},
  "403": {},
  "405": {},
  "500": {},
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "username": "<string>",
  "profileImageUrl": "<string>",
  "lastSignInAt": "<string>",
  "publicMetadata": {},
  "createdAt": "<string>",
  "role": "<string>",
  "activityStatus": "<string>",
  "invitationStatus": "<string>",
  "invitationCreatedAt": "<string>"
}

GET

admin

getUsersInOrg

Get Organization Users

curl --request GET \
  --url https://asteragents.com/api/admin/getUsersInOrg \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://asteragents.com/api/admin/getUsersInOrg', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://asteragents.com/api/admin/getUsersInOrg",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://asteragents.com/api/admin/getUsersInOrg"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://asteragents.com/api/admin/getUsersInOrg")

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

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

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

{
  "400": {},
  "401": {},
  "403": {},
  "405": {},
  "500": {},
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "username": "<string>",
  "profileImageUrl": "<string>",
  "lastSignInAt": "<string>",
  "publicMetadata": {},
  "createdAt": "<string>",
  "role": "<string>",
  "activityStatus": "<string>",
  "invitationStatus": "<string>",
  "invitationCreatedAt": "<string>"
}

DEPRECATED: This endpoint has been replaced by the new RESTful API structure.Please migrate to:

GET /admin/users - For active users
GET /admin/invitations - For pending invitations

This endpoint will be removed in a future version.

This endpoint requires organization admin privileges. Only users with the org:admin role can access organization user data.

Returns a list of all users and pending invitations for the organization, including their profile information, roles, activity status, and custom metadata. Perfect for user management automation and bulk operations.

Authentication

string

required

Bearer token for authentication. Must be from a user with org:admin role.

Query Parameters

string

Filter users by activity status. Options: active, pending, inactive

string

Filter users by organization role. Options: org:admin, org:member

Response

Returns an array of user objects with comprehensive details:

string

Unique Clerk user identifier. null for pending invitations that haven’t been accepted.

string

User’s email address

string

User’s first name

string

User’s last name

string

User’s username (if set)

string

URL to user’s profile image/avatar

ISO 8601 timestamp of user’s last sign-in

object

Organization-scoped user metadata (department, role, vnum, etc.). Each organization maintains separate metadata for shared users.

string

ISO 8601 timestamp when user account was created

string

User’s role in the organization (e.g., “org:admin”, “org:member”)

string

User’s activity status: active (current member), pending (invitation sent but not accepted), inactive (invitation revoked)

string

Clerk invitation status if applicable: pending, accepted, revoked, or null for users without invitation history

string

ISO 8601 timestamp when invitation was created, or null for users without invitation history

Examples

curl -X GET "https://asteragents.com/api/admin/getUsersInOrg?activityStatus=active&role=org:admin" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

const response = await fetch('/api/admin/getUsersInOrg?activityStatus=active', {
  headers: {
    'Authorization': 'Bearer ' + token
  }
});

const activeUsers = await response.json();
console.log(`Found ${activeUsers.length} active users`);

import requests

response = requests.get(
    'https://asteragents.com/api/admin/getUsersInOrg',
    headers={'Authorization': f'Bearer {token}'}
)

users = response.json()
print(f"Found {len(users)} users in organization")

[
  {
    "id": "user_2ABC123DEF",
    "email": "john.doe@company.com",
    "firstName": "John",
    "lastName": "Doe",
    "username": "johndoe",
    "profileImageUrl": "https://img.clerk.com/profile.jpg",
    "lastSignInAt": "2024-01-15T10:30:00.000Z",
    "publicMetadata": {
      "department": "engineering",
      "role": "manager",
      "vnum": "123",
      "team": "backend"
    },
    "createdAt": "2023-12-01T08:00:00.000Z",
    "role": "org:admin",
    "activityStatus": "active",
    "invitationStatus": null,
    "invitationCreatedAt": null
  },
  {
    "id": "user_2XYZ789GHI",
    "email": "sarah.smith@company.com",
    "firstName": "Sarah",
    "lastName": "Smith",
    "username": null,
    "profileImageUrl": null,
    "lastSignInAt": "2024-01-14T16:45:00.000Z",
    "publicMetadata": {
      "department": "marketing",
      "role": "member",
      "vnum": "456"
    },
    "createdAt": "2024-01-10T12:30:00.000Z",
    "role": "org:member",
    "activityStatus": "active",
    "invitationStatus": null,
    "invitationCreatedAt": null
  },
  {
    "id": null,
    "email": "pending.user@company.com",
    "firstName": null,
    "lastName": null,
    "username": null,
    "profileImageUrl": null,
    "lastSignInAt": null,
    "publicMetadata": {},
    "createdAt": "2024-01-20T09:15:00.000Z",
    "role": "org:member",
    "activityStatus": "pending",
    "invitationStatus": "pending",
    "invitationCreatedAt": "2024-01-20T09:15:00.000Z"
  }
]

Error Codes

object

Bad Request - User is not part of any organization

object

Unauthorized - Invalid or missing authentication

object

Forbidden - User is not an admin in the organization

object

Method Not Allowed - Only GET requests are accepted

object

Internal Server Error - Unexpected error occurred

Use Cases

Bulk User Operations

Filter and process users based on metadata:

// Find all users in engineering department
const engineeringUsers = users.filter(user => 
  user.publicMetadata?.department === 'engineering'
);

// Find users by vnum
const specificUsers = users.filter(user => 
  user.publicMetadata?.vnum === '123'
);

User Management Dashboard

Build custom admin interfaces with complete user data:

# Create user summary report
for user in users:
    print(f"{user['email']} - {user['role']} - Last active: {user['lastSignInAt']}")

Invitation Status Check

Use this endpoint to verify which users have accepted invitations:

// Users with recent sign-ins have likely accepted invitations
const activeUsers = users.filter(user => user.lastSignInAt);
const pendingUsers = users.filter(user => !user.lastSignInAt);

Features

Complete User Data: Access all user profile information, roles, and custom metadata in a single request.

Organization-Scoped Metadata: Each organization maintains separate metadata for users - perfect for multi-org scenarios
Metadata Filtering: Use publicMetadata to filter users by department, role, vnum, or any custom fields within your organization
Role Management: See each user’s organization role (admin vs member)
Activity Tracking: Check last sign-in times to identify active vs inactive users
Bulk Operations: Process multiple users programmatically for invitations, role changes, etc.

Notes

Results are ordered by email address alphabetically
Only returns users who are active members of the organization
Metadata is organization-scoped: Users in multiple organizations have separate metadata per org
Metadata structure depends on what was set during user invitation or updates via Update User Metadata
lastSignInAt will be null for users who haven’t signed in yet (pending invitations)
Use this data to identify users for bulk operations like role updates or removal

API Documentation

Admin API

Files API

Agents API

Tools API

Agent Tags API

Knowledge Bases API

Skills API

Conversations API

Scheduled Tasks API

Other Endpoints

Legacy Endpoints (Deprecated)

Get Organization Users

Authentication

Query Parameters

Response

Examples

Error Codes

Use Cases

Bulk User Operations

User Management Dashboard

Invitation Status Check

Features

Notes

​Authentication

​Query Parameters

​Response

​Examples

​Error Codes

​Use Cases

​Bulk User Operations

​User Management Dashboard

​Invitation Status Check

​Features

​Notes

Authentication

Query Parameters

Response

Examples

Error Codes

Use Cases

Bulk User Operations

User Management Dashboard

Invitation Status Check

Features

Notes