Search users in your accessible scope
GET /users
GET /users
Operation
GET
/users
Searches users by name, email, or account filters in the caller's accessible scope. Admin callers can search all users, while non-admin callers are scoped to their own user record. Use q/query/search for free-form lookup, and publisher_id, agency_id, network_id, advertiser_id, or admin for exact filtering.
Operation ID:
searchUsers
·
Tags: Users
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
q
|
query | No | string | Preferred free-form query |
query
|
query | No | string | Alias for q |
search
|
query | No | string | Legacy alias for q |
email
|
query | No | string | Email filter or lookup string |
name
|
query | No | string | Name filter or lookup string |
given_name
|
query | No | string | Given name filter or lookup string |
family_name
|
query | No | string | Family name filter or lookup string |
publisher_id
|
query | No | integer | Publisher filter |
agency_id
|
query | No | integer | Agency filter |
network_id
|
query | No | integer | Network filter |
advertiser_id
|
query | No | integer | Advertiser filter |
admin
|
query | No | boolean | Admin flag filter |
page
|
query | No | integer | Page number |
per_page
|
query | No | integer | Results per page |
limit
|
query | No | integer | Upper bound on returned results |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "User search results",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"next_page": {
"type": "integer",
"nullable": true
},
"prev_page": {
"type": "integer",
"nullable": true
},
"per_page": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
},
"required": [
"current_page",
"next_page",
"prev_page",
"per_page",
"total_count",
"total_pages"
]
}
},
"required": [
"data",
"meta"
]
},
"examples": {
"user_search_results": {
"summary": "Successful user search response",
"value": {
"data": [
{
"id": 42,
"type": "user",
"attributes": {
"email": "[email protected]",
"name": "Person Example",
"given_name": "Person",
"family_name": "Example",
"admin": false,
"publisher_id": 123,
"agency_id": null,
"network_id": null,
"advertiser_id": null,
"referred_by_id": 7,
"api_call_count": 0
}
}
],
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"per_page": 20,
"total_count": 1,
"total_pages": 1
}
}
}
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/Forbidden"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Search users in your accessible scope | GET |
/api/v1/users |
OpenAPI operationId: searchUsers. |
GET /api/v1/users
OpenAPI
Search users in your accessible scope