Search Team Users
Search team users by name, display name, or email. Supports pagination.
GET
/v2/team/users/search
Query Parameters
search_term string
Term to search for (e.g., 'josh', 'gmail.com').
search_by string
Field to search by (e.g., 'name', 'display_name', 'user_id').
query_amount number
Max results per page (alias for per_page).
page number
Zero-based page index (default 0).
cURl example
curl -X GET 'https://lunarsend.com/api/v2/team/users/search?query_amount=20&page=0' \
-H 'x-api-key: $LUNARSEND_API_KEY' \
-H 'Accept: application/json'Response
{
"data": [
{
"created_at": "2025-05-19T20:07:04.643689+00:00",
"name": "john",
"email": "john.doe@company.com",
"display_name": "Jack",
"user_id": "66f463d7-3107-4957-8b71-ab03acc319e2",
"profile_picture": null
},
{
"created_at": "2025-05-22T18:46:04.441494+00:00",
"name": "Jane",
"email": "Jane.doe@company.com",
"display_name": "Jane",
"user_id": "f416e4f9-5110-4ar5-92bd-53a4a0c54496",
"profile_picture": null
}
],
"total_count": 2,
"page": 0,
"per_page": 20
}Response Fields
| Field | Type | Status | Format | Notes |
|---|---|---|---|---|
| total_count | int | read-only optional | - | Total users that match the search criteria. |
| page | int | read-only optional | - | Zero-based page index. |
| per_page | int | read-only optional | - | Results per page. |
| data | object | required | - | - |
| data.created_at | string (ISO 8601) | read-only optional | date-time | Server-assigned user creation timestamp. |
| data.name | string | required | - | - |
| data.email | string | required | - | |
| data.display_name | string | required | - | - |
| data.user_id | string (uuid) | read-only optional | uuid | User UUID. |
| data.profile_picture | string (URL) | optional nullable | url | URL to the user's avatar, if set; null otherwise. |