API reference › Preferred lists › Preferred list
Export preference list to Excel
GET /v1/settings/portal/preference-list-export
- Scope
settings_preferred_users:read- Roles
- client, consumer, service-provider
- Rate limit
- heavy
Lower rate limit: this route counts against the exports and reports limit. See Rate limits.
Exports the full preference list to an Excel (.xlsx) file for download.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
type | string | Optional output format. One of: |
id | string | Optional ID or comma separated IDs |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/preference-list-export" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Excel file containing preference list data
Excel file containing preference list data
{
"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)
| Field | Type | Description |
|---|---|---|
queued | boolean | Example |
export_id | integer | 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 |
message | string | Example |
401 Not signed in
Unauthorized - authentication required
{
"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 'settings_preferred_users: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 |
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
Internal server error
{
"success": false,
"message": "Preference list export failed. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |