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

NameTypeDescription
id requiredstring

Unique identifier of the organization location

Example ORGLOC-4GVGJ.

tab requiredstring

Identifier for the specific tab to fetch (e.g., 'general', 'requirement_preferences', 'domain_information', 'document_notes','requirementAndPreferences')

One of: general, requirement_preferences, rates_billing, document_notes, requirementAndPreferences. Example general.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

dataobject
data.idstring

Example ORG-MARH4E.

data.namestring

Example Demo Tenant.

data.descriptionstring

Example This is a demo tenant for showcasing purposes..

data.logostring or null
data.departmentstring

Example Test.

data.contactImagestring or null
data.contactNamestring

Example Contact Name.

data.contactEmailstring

Example user@example.com.

data.contactRolestring

Example Role.

data.contactPhonestring

Example +1-234-567-8900.

data.contactPhoneTypestring

Example voice_only.

data.addressLine1string

Example addressLine1.

data.addressLine2string

Example addressLine2.

data.citystring

Example City.

data.statestring

Example State.

data.postalCodestring

Example 12345.

data.accessInstructionstring

Example Access instructions text.

401 Not signed in

Unauthorized - authentication required

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

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.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_locations:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified organization does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..