API reference › Clients › Locations
Retrieve a list of client locations
GET /v1/clients/{client}/locations
- Scope
clients:read- Roles
- admin, scheduler
Fetches a paginated list of client locations based on filters like search, client, location, sorting, etc.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
client required | string | Unique identifier of the client Example |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter locations by name, address, city, etc. |
location | string | Filter locations by location name. |
columns | string | Search query within visible column content. Example |
isPublished | boolean | Filter clients location by their Published status. Example |
status | integer | Filter locations by status id (from the statuses lookup table). Example |
startDate | string (date) | Filter locations created on or after this date (YYYY-MM-DD). |
endDate | string (date) | Filter locations created on or before this date (YYYY-MM-DD). |
sortBy | string | Sort locations by a specific field (e.g., 'name', 'created_at'). |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of locations to retrieve per page. |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/clients/{client}/locations" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Locations retrieved successfully
Locations retrieved successfully
{
"success": true,
"data": [
{
"id": "CLTLOC-HQBS7",
"locationName": "Main Office",
"logo": "https://cdn.example.com/image.png",
"addressLine1": "123 Main St",
"addressLine2": "Suite 200",
"city": "Austin",
"state": {
"id": 1,
"label": "Example label",
"code": "string"
},
"postalCode": "90210",
"status": 1,
"statusName": "Active",
"isPublished": true,
"isDefault": true,
"isPrimaryAddress": true,
"department": "Radiology",
"contactName": "Jane Smith",
"contactImage": "https://cdn.example.com/image.png",
"contactEmail": "user@example.com",
"contactPhone": "+1-555-0142",
"contactPhoneExtension": "101",
"contactPhoneType": "sms_and_voice",
"countryCode": "+1",
"client": "CLT-XWB2RY",
"clientName": "Example name",
"clientImage": "https://cdn.example.com/image.png",
"onlineStatus": "online",
"clientEmail": "user@example.com",
"clientPhone": "+1-555-0142",
"clientType": "Individual",
"timezone": "America/New_York"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (39)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (32 nested) | |
meta | object (4 nested) |
Nested fields
data 32 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].locationName | string | Example |
data[].logo | string or null | Example |
data[].addressLine1 | string or null | Example |
data[].addressLine2 | string or null | Example |
data[].city | string or null | Example |
data[].state | object or null | |
data[].state.id | integer | Example |
data[].state.label | string | Example |
data[].state.code | string | |
data[].postalCode | string or null | Example |
data[].status | integer or null | Example |
data[].statusName | string or null | Example |
data[].isPublished | boolean | Example |
data[].isDefault | boolean | Example |
data[].isPrimaryAddress | boolean | Example |
data[].department | string or null | Example |
data[].contactName | string or null | Example |
data[].contactImage | string or null | Example |
data[].contactEmail | string or null | Example |
data[].contactPhone | string or null | Example |
data[].contactPhoneExtension | string or null | Example |
data[].contactPhoneType | string or null | Example |
data[].countryCode | string or null | Example |
data[].client | string | Example |
data[].clientName | string or null | Example |
data[].clientImage | string or null | Example |
data[].onlineStatus | string | Example |
data[].clientEmail | string or null | Example |
data[].clientPhone | string or null | Example |
data[].clientType | string or null | Example |
data[].timezone | string or null | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Invalid parameters. Ensure all required filters are correct."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'clients:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |