API reference › Organization locations

Retrieve a list of organization locations

GET /v1/organization-locations

Scope
settings_locations:read
Roles
admin, scheduler

Fetches a paginated list of organization locations based on search criteria, filters, and sorting options.

Parameters

Query parameters

NameTypeDescription
searchstring

Search query to filter organization locations by name or other attributes.

columnsstring

Search query within visible column content.

Example name,department,status,contactName,contactEmail,addressLine1.

startDatestring (date)

Filter organizations created on or after this date (YYYY-MM-DD).

endDatestring (date)

Filter organizations created on or before this date (YYYY-MM-DD).

sortBystring

Sort organizations by a specific field (e.g., 'name', 'created_at').

sortOrderstring

Sorting order: ascending ('asc') or descending ('desc').

One of: asc, desc.

perPageinteger

Number of organizations to retrieve per page.

pageinteger

Page number (default: 1).

Example 1.

isPublishedstring

Filter by publish state: true for published locations, false for drafts. Omit for both.

One of: true, false. Example true.

statusinteger

Filter by status id.

Example 1.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/organization-locations" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Organization locations retrieved successfully

Organization locations retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "startTime": "09:00:00",
      "endTime": "09:00:00",
      "convertedStartDate": "2026-01-15",
      "convertedEndDate": "2026-01-15",
      "convertedStartTime": "09:00:00",
      "convertedEndTime": "09:00:00",
      "userTimezone": "America/New_York",
      "timezone": "America/New_York",
      "assignmentDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
      "userDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
      "requestedOn": "string",
      "submissionDate": "2026-01-15",
      "timeSlots": {
        "id": 1,
        "startTime": "09:00:00",
        "endTime": "09:00:00"
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 1
  }
}
Response fields (25)

3 top-level fields; 2 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

dataarray of object (18 nested)
metaobject (4 nested)

Nested fields

data 18 fields
FieldTypeDescription
data[].startDatestring (date)

Example 2026-01-15.

data[].endDatestring (date)

Example 2026-01-15.

data[].startTimestring (time)

Example 09:00:00.

data[].endTimestring (time)

Example 09:00:00.

data[].convertedStartDatestring (date)

Example 2026-01-15.

data[].convertedEndDatestring (date)

Example 2026-01-15.

data[].convertedStartTimestring (time)

Example 09:00:00.

data[].convertedEndTimestring (time)

Example 09:00:00.

data[].userTimezonestring

Example America/New_York.

data[].timezonestring

Example America/New_York.

data[].assignmentDateTooltipstring

Example Jan 15, 2026 9:00 AM – 11:00 AM.

data[].userDateTooltipstring

Example Jan 15, 2026 9:00 AM – 11:00 AM.

data[].requestedOnstring

Example string.

data[].submissionDatestring (date)

Example 2026-01-15.

data[].timeSlotsobject
data[].timeSlots.idinteger

Example 1.

data[].timeSlots.startTimestring (time)

Example 09:00:00.

data[].timeSlots.endTimestring (time)

Example 09:00:00.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 1.

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

Scope, tenant, IP allow-list or RBAC check failed.

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 .

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..