API reference › Organization locations
Retrieve specific tab details of an organization location
GET /v1/organization-location/{id}/{tab}
- Scope
settings_locations:read- Roles
- admin, scheduler
Fetches the details for a specific tab within an organization, based on the provided organization ID and tab identifier.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Unique identifier of the organization location Example |
tab required | string | Identifier for the specific tab to fetch (e.g., 'general', 'requirement_preferences', 'domain_information', 'document_notes','requirementAndPreferences') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/organization-location/{id}/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Organization location retrieved successfully
Organization location retrieved successfully
{
"success": true,
"data": {
"id": "ORG-MARH4E",
"name": "Demo Tenant",
"description": "This is a demo tenant for showcasing purposes.",
"logo": null,
"department": "Test",
"contactImage": null,
"contactName": "Contact Name",
"contactEmail": "user@example.com",
"contactRole": "Role",
"contactPhone": "+1-234-567-8900",
"contactPhoneType": "voice_only",
"addressLine1": "addressLine1",
"addressLine2": "addressLine2",
"city": "City",
"state": "State",
"postalCode": "12345",
"accessInstruction": "Access instructions text"
}
}Response fields (19)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object | |
data.id | string | Example |
data.name | string | Example |
data.description | string | Example |
data.logo | string or null | |
data.department | string | Example |
data.contactImage | string or null | |
data.contactName | string | Example |
data.contactEmail | string | Example |
data.contactRole | string | Example |
data.contactPhone | string | Example |
data.contactPhoneType | string | Example |
data.addressLine1 | string | Example |
data.addressLine2 | string | Example |
data.city | string | Example |
data.state | string | Example |
data.postalCode | string | Example |
data.accessInstruction | 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
Forbidden. The rates_billing tab is Finances data, so a role without Finance Read is refused it whatever it holds on the record's own module. Every other tab follows the record's module alone.
{
"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 parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified organization does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
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 |