List handshakes for the organization
GET /v1/handshakes
- Scope
handshakes:read- Roles
- admin, scheduler
Paginated list of every handshake in the tenant, with optional status, assignment, date-range and free-text filters.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
status | string | Filter by handshake status. Example |
assignment_id | string | Only handshakes for this assignment. |
search | string | Free-text search across the selected columns. |
columns | string | Comma-separated columns the search applies to. Example |
startDate | string (date) | |
endDate | string (date) | |
sortBy | string | |
sortOrder | string | One of: |
perPage | integer | Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/handshakes" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Handshakes retrieved
Handshakes retrieved.
{
"success": true,
"data": [
{}
],
"meta": {
"currentPage": 1,
"lastPage": 3,
"perPage": 10,
"total": 27
}
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object | |
meta | object | |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'handshakes: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: |