API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/users

ark.search_users

Searches active organization users visible through the connected actor team scope.

Availability: Core preview
Scopes: people:read
ARK permissions: canViewPeople
Team visibility: Required and enforced
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

qquerystring: min length: 1; max length: 100
team_idsquerystring: Comma-separated visible team IDs.
rolesquerystring: Comma-separated user roles.
include_inactivequeryboolean: default: false
limitqueryinteger: default: 25; min: 1; max: 100
cursorquerystring

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/users' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Visible users

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.itemsarray<object>required

data.paginationobjectrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied