API reference › Clients › Consumers in the client portal

Export all Consumers in client portal to Excel

GET /v1/settings/portal/client/export-consumers

Scope
clients:read
Roles
client
Rate limit
heavy

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

Exports all consumers in client portal to an Excel file for download.

Parameters

Query parameters

NameTypeDescription
typestring

Optional output format. csv downloads the file as CSV; omitted or xlsx keeps the default XLSX.

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

idstring

Optional ID or comma separated IDs

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

Example request

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

Try it

Responses

200 CSV file containing all consumers

CSV file containing all consumers

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 'clients: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 'clients: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..