API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/customers
ark.search_customers
Searches customers visible to the connected actor by name, code, and team visibility.
- Availability
- Core preview
- Scopes
customers:read- ARK permissions
canViewCustomers- 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 team IDs. Omit to use all teams visible to the connected user.
limitqueryinteger- default: 25; min: 1; max: 100
cursorquerystring
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/customers' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Visible customer search results
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.itemsarray<object>requireddata.paginationobjectrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied