API reference › Requests › Provider portal
Retrieve a single request assignment entry by ID
GET /v1/portal/provider/requests/{id}
- Scope
requests:read- Roles
- service-provider
Returns details of a specific assignment entry including dates, times, providers, address, services, and status.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | The ID of the assignment entry Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/portal/provider/requests/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Assignment entry retrieved successfully
Assignment entry retrieved successfully
{
"success": true,
"message": "Assignment list entry retrieved.",
"data": {
"startDate": "9/05/2025",
"endDate": "9/06/2025",
"startTime": "11:00 AM",
"endTime": "5:00 PM",
"id": "ASG-JSPYP1",
"assignmentName": "Assignment 1",
"partialCoverage": false,
"estimatePay": 0,
"address": {
"onsite": {
"title": "Primary Location",
"onSiteType": "client",
"address": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"postalCode": null
}
}
},
"serviceTypes": [
{
"id": 1,
"label": "ASL"
}
],
"providers": [
"1 Deaf"
],
"duration": null,
"status": {
"id": 1,
"name": "Pending"
},
"certification": []
}
}Response fields (25)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (22 nested) |
Nested fields
data 22 fields
| Field | Type | Description |
|---|---|---|
data.startDate | string | Example |
data.endDate | string | Example |
data.startTime | string | Example |
data.endTime | string | Example |
data.id | string | Example |
data.assignmentName | string | Example |
data.partialCoverage | boolean | Example |
data.estimatePay | number | Example |
data.address | object | |
data.address.onsite | object | |
data.address.onsite.title | string | Example |
data.address.onsite.onSiteType | string | Example |
data.address.onsite.address | object | |
data.serviceTypes | array of object | |
data.serviceTypes[].id | integer | Example |
data.serviceTypes[].label | string | Example |
data.providers | array of string | |
data.duration | string or null | |
data.status | object | |
data.status.id | integer | Example |
data.status.name | string | Example |
data.certification | array of string |
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 'requests: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 |
404 Not found
Assignment entry not found
{
"success": false,
"message": "Assignment entry not found.",
"errors": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string |
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
Server error
{
"success": false,
"message": "Something went wrong!",
"errors": "Unexpected error occurred."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |