API reference › Requests › Client portal

Retrieve specific tab details of a request

GET /v1/settings/portal/client/request/{id}/{tab}

Scope
requests:read
Roles
client

Fetches the details for a specific tab within a request, based on the provided request ID and tab identifier.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Unique identifier of the request

Example ASM-ZGJ8T2.

tab requiredstring

Identifier for the specific tab to fetch (e.g., 'details','providers','requirementPreferences','documents','sidebar','summary','historyLogs')

One of: details, requirementPreferences, documents, sidebar, summary, historyLogs. Example details.

Query parameters

NameTypeDescription
searchstring

Search the audit log. Applies to the historyLogs tab only.

sortBystring

Sort column (default: created_at). Applies to the historyLogs tab only.

Example created_at.

sortOrderstring

Sort direction (default: desc). Applies to the historyLogs tab only.

One of: asc, desc. Example desc.

perPageinteger

Rows per page (default: 10). Applies to the historyLogs tab only.

Example 10.

pageinteger

Page number (default: 1). Applies to the historyLogs tab only.

Example 1.

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

Example request

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

Try it

Responses

200 Request details retrieved successfully

Request details retrieved successfully

JSON
{
  "success": true,
  "data": {
    "id": "ASM-MARH4E",
    "title": "Request Title"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

dataobject
data.idstring

Example ASM-MARH4E.

data.titlestring

Example Request Title.

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified request does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
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": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..