API reference › Assignments › Provider portal

Retrieve single assignment details

GET /v1/settings/portal/provider/assignment/{id}

Scope
assignments:read
Roles
service-provider

Fetches detailed information about a specific assignment for the service provider. When the provider holds only part of a partial-coverage job, myTime and myConvertedTime carry their own covered hours ('12:00 PM to 4:00 PM', separate runs joined with ', ') in the work item's and the provider's timezone; both are null when they hold the whole job.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Unique identifier of the assignment.

Example ASG-23RT45.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/portal/provider/assignment/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment details retrieved successfully

Assignment details retrieved successfully

JSON
{
  "success": true,
  "message": "Assignment data retrieved successfully.",
  "data": {
    "assignmentId": "ASG-23RT45",
    "title": "Assignment Title",
    "description": "Assignment description",
    "status": "Active",
    "priority": "High"
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment data retrieved successfully..

dataobject
data.assignmentIdstring

Example ASG-23RT45.

data.titlestring

Example Assignment Title.

data.descriptionstring

Example Assignment description.

data.statusstring

Example Active.

data.prioritystring

Example High.

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 'assignments: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 'assignments:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment not found

JSON
{
  "success": false,
  "message": "Not Found",
  "errors": "Assignment data not found."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Not Found.

errorsstring

Example Assignment data not found..

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