API reference › Organization locations
Retrieve active and published locations for a specific organization
GET /v1/organization/active-locations
- Scope
settings_locations:read- Roles
- admin, scheduler
Fetches only the locations that are both active (status) and published for the current portal organization (based on portalOrganizationId), returning minimal details such as label, address, and primary flag.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/organization/active-locations" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Active and published organization location details retrieved successfully
Active and published organization location details retrieved successfully
{
"success": true,
"message": "Active published Organization Location details retrieved!",
"data": [
{
"id": "CLTLOC-HQBS7",
"label": "Example label",
"addressLine1": "123 Main St",
"addressLine2": "Suite 200",
"city": "Austin",
"state": {
"id": 1,
"label": "Example label",
"code": "string"
},
"postalCode": "90210",
"isPrimary": true,
"isDefault": true
}
]
}Response fields (15)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | string | Example |
data[].label | string | Example |
data[].addressLine1 | string | Example |
data[].addressLine2 | string | Example |
data[].city | string | Example |
data[].state | object | |
data[].state.id | integer | Example |
data[].state.label | string | Example |
data[].state.code | string | Example |
data[].postalCode | string | Example |
data[].isPrimary | boolean | Example |
data[].isDefault | boolean | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'settings_locations: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 |
422 Validation failed
Validation error - Missing or invalid Organization ID
{
"success": false,
"message": "Organization ID is required.",
"errors": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null |
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."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |