API reference › Requests › Client portal

Export All Requests to CSV

GET /v1/settings/portal/client/requests/export

Scope
requests:read
Roles
client
Rate limit
heavy

Lower rate limit: this route counts against the exports and reports limit. See Rate limits.

Exports all requests to an CSV file for download.

Parameters

Query parameters

NameTypeDescription
typestring

Record filter (all, active, archived; default all). Also accepted as the output format: csv downloads CSV, xlsx keeps the default — in which case the record filter falls back to all. To use both, keep type as the filter and pass exportType=csv.

Example active.

exportTypestring

Output format for endpoints where type already means something else. On this route type is the record filter, so pass the format here: exportType=csv. If type itself is csv/xlsx it is read as the format and the record filter falls back to its default.

One of: xlsx, csv. Default "xlsx".

idstring

Optional ID or comma separated IDs

typestring

Type of requests to export. Options: all (default), active, archived.

One of: all, active, archived. Example active.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/portal/client/requests/export" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 CSV file containing requests

CSV file containing requests

JSON
{
  "queued": true,
  "export_id": 184,
  "message": "Exporting 2,500 records. You'll receive an in-app and email notification once your file is ready to download."
}
Response fields (3)
FieldTypeDescription
queuedboolean

Example true.

export_idinteger

Identifies the queued export. The file is delivered through the in-app and email notification; the export-status endpoints are not part of the External API.

Example 184.

messagestring

Example Exporting 2,500 records. You'll receive an in-app and email notification once your file is ready to download..

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 .

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