API reference › Consumers › Consumer portal

Retrieve specific tab details of a consumer portal

GET /v1/settings/portal/consumer/{tab}

Scope
consumers:read
Roles
consumer

Fetches the details for a specific tab within a consumer portal based on the authenticated user. Supports optional filtering by client name or relationship name.

Parameters

Path parameters

NameTypeDescription
tab requiredstring

Identifier for the specific tab to fetch (e.g., 'details', 'localizations', 'associated_service_organizations','notifications_access','requirements_preferences')

One of: details, localizations, associated_service_organizations, notifications_access, requirements_preferences. Example details.

Query parameters

NameTypeDescription
clientstring

Filter associated clients by client ID

Example CLT-123456.

relationshipinteger

Filter associated clients by relationship ID

Example 2.

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

Example request

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

Try it

Responses

200 Consumer portal details retrieved successfully

Consumer portal details retrieved successfully

JSON
{
  "success": true,
  "message": "Consumer details retrieved!",
  "data": {
    "id": "CSM-PDZTZ9",
    "name": "test",
    "description": "I am doing testing",
    "email": "user@example.com",
    "logo": "https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg",
    "countryCode": "+1",
    "phone": "9786159228",
    "phoneExtension": "null",
    "phoneType": "sms_and_voice",
    "videoPhoneCountryCode": "+1",
    "videoPhone": "9786159226",
    "addressLine1": "123 Bark Street",
    "addressLine2": "3434 Street",
    "city": "Austin1",
    "state": null,
    "postalCode": "33629"
  }
}
Response fields (19)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Consumer details retrieved!.

dataobject
data.idstring

Example CSM-PDZTZ9.

data.namestring

Example test.

data.descriptionstring

Example I am doing testing.

data.emailstring

Example user@example.com.

data.logostring

Example https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg.

data.countryCodestring

Example +1.

data.phonestring

Example 9786159228.

data.phoneExtensionstring

Example null.

data.phoneTypestring

Example sms_and_voice.

data.videoPhoneCountryCodestring

Example +1.

data.videoPhonestring

Example 9786159226.

data.addressLine1string

Example 123 Bark Street.

data.addressLine2string

Example 3434 Street.

data.citystring

Example Austin1.

data.statestring or null
data.postalCodestring

Example 33629.

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 'consumers: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 'consumers: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 consumer portal 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..