API reference › Team › Schedulers
Retrieve scheduler list
GET /v1/scheduler
- Scope
team:read- Roles
- admin, scheduler
Fetch paginated list of schedulers with search, filters, and sorting
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search by scheduler name or email Example |
status | integer | Filter by status ID Example |
isPublished | boolean | Filter by published status Example |
startDate | string (date) | Filter schedulers created after this date Example |
endDate | string (date) | Filter schedulers created before this date Example |
columns | string | Comma-separated searchable columns Example |
sortBy | string | Sort field Example |
sortOrder | string | Sort order One of: |
perPage | integer | Items per page Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/scheduler" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Schedulers retrieved successfully
Schedulers retrieved successfully
{
"success": true,
"data": [
{
"id": "USR-LBW3CV",
"name": "Example name",
"email": "user@example.com",
"logo": "https://cdn.example.com/image.png",
"onlineStatus": "online",
"description": "Short human-readable description.",
"countryCode": "+1",
"phone": "+1-555-0142",
"phoneExtension": "101",
"phoneType": "sms_and_voice",
"addressLine1": "123 Main St",
"addressLine2": "Suite 200",
"city": "Austin",
"state": {
"id": 1,
"label": "Alabama"
},
"postalCode": "90210",
"videoPhone": "+1-555-0142",
"videoPhoneCountryCode": "+1",
"isPublished": true,
"status": {
"id": 1,
"label": "Active"
},
"statusChangedAt": "2026-06-30 14:29:08",
"publishedAt": "2026-06-30 14:29:08",
"createdAt": "2026-01-15",
"lastLogin": "2026-01-15 09:00:00",
"canLogin": true,
"jobRole": "string",
"role": "example-slug",
"requiresPrimaryReassignmentOnDelete": true,
"otherActiveRoles": [
null
]
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (39)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (32 nested) | |
meta | object (4 nested) |
Nested fields
data 32 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].name | string | Example |
data[].email | string or null | Example |
data[].logo | string or null | Example |
data[].onlineStatus | string | Example |
data[].description | string or null | Example |
data[].countryCode | string or null | Example |
data[].phone | string or null | Example |
data[].phoneExtension | string or null | Example |
data[].phoneType | string or null | Example |
data[].addressLine1 | string or null | Example |
data[].addressLine2 | string or null | Example |
data[].city | string or null | Example |
data[].state | object | |
data[].state.id | integer | Example |
data[].state.label | string | Example |
data[].postalCode | string or null | Example |
data[].videoPhone | string or null | Example |
data[].videoPhoneCountryCode | string or null | Example |
data[].isPublished | boolean | Example |
data[].status | object | |
data[].status.id | integer | Example |
data[].status.label | string | Example |
data[].statusChangedAt | string (date-time) or null | When the scheduler entered its current status Example |
data[].publishedAt | string (date-time) or null | When the scheduler entered its current publication state Example |
data[].createdAt | string or null | Example |
data[].lastLogin | string or null | Example |
data[].canLogin | boolean | Example |
data[].jobRole | string or null | |
data[].role | string or null | Example |
data[].requiresPrimaryReassignmentOnDelete | boolean | Example |
data[].otherActiveRoles | array of any |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request
{
"success": false,
"message": "Invalid parameters."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized
{
"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 'team: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 |
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": "Failed to fetch schedulers."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |