API reference › General settings › Travel radius

Retrieve all travel radii

GET /v1/travel-radius

Scope
settings_general:read
Roles
admin, scheduler

Fetch a list of all travel radii.

Parameters

Query parameters

NameTypeDescription
searchstring

Global search term across selected columns

Example completed.

columnsstring

Comma-separated list of columns to search (e.g., name)

Example name.

Namestring

Search by name or ID

Example Completed.

sortBystring

Field to sort by

Example name.

sortOrderstring

Sorting order (asc or desc)

One of: asc, desc. Example asc.

perPageinteger

Number of items per page

Example 10.

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

Example request

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

Try it

Responses

200 Travel Radius retrieved successfully

Travel Radius retrieved successfully

JSON
{
  "success": true,
  "message": "Travel Radii Retrieved!",
  "data": [
    {
      "id": 1,
      "name": "Example name",
      "minDistance": "string",
      "maxDistance": "string",
      "unit": "hour"
    }
  ]
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Travel Radii Retrieved!.

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Example Example name.

data[].minDistancestring

Example string.

data[].maxDistancestring

Example string.

data[].unitstring

Example hour.

400 Bad request

Invalid argument provided

JSON
{
  "success": false,
  "message": "Failed to retrieve."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

401 Not signed in

Missing, invalid or expired API key.

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_general: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_general: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": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.