API reference › Clients › Consumers in the client portal
Retrieve specific tab details of a consumer in client portal
GET /v1/settings/portal/client/consumers/{consumer}/tab/{tab}
- Scope
clients:read- Roles
- client
Fetches the details for a specific tab within a consumer, based on the provided consumer ID and tab identifier in client portal.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
consumer required | string | Unique identifier of the consumer Example |
tab required | string | Identifier for the specific tab to fetch (e.g., 'general', 'requirement_preferences', 'localizations', 'document_notes') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/client/consumers/{consumer}/tab/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Consumer details retrieved successfully
Consumer details retrieved successfully
{
"success": true,
"message": "Consumer details retrieved!",
"data": {
"id": "CSM-PMJKT2",
"name": "ABCD",
"description": "Test description",
"email": "user@example.com",
"logo": null,
"countryCode": "+1",
"phone": "9888888888",
"phoneType": "sms_and_voice",
"videoPhoneCountryCode": "+1",
"videoPhone": "9888888888",
"addressLine1": "101 Street",
"addressLine2": "Beagle Run",
"city": "Austin",
"state": "1",
"postalCode": "78759",
"portalAccess": false,
"assignmentUpdates": false,
"serviceReminders": false,
"receiveEmail": false,
"receiveSms": false,
"receiveInApp": false,
"profileShareWithinOrganization": false,
"isPublished": true,
"networkAccess": false,
"status": 1,
"priority": 1,
"communicationModes": [
1,
2
],
"hearingStatus": "Deaf"
}
}Response fields (31)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (28 nested) |
Nested fields
data 28 fields
| Field | Type | Description |
|---|---|---|
data.id | string | Example |
data.name | string | Example |
data.description | string | Example |
data.email | string | Example |
data.logo | string or null | |
data.countryCode | string | Example |
data.phone | string | Example |
data.phoneType | string | Example |
data.videoPhoneCountryCode | string | Example |
data.videoPhone | string | Example |
data.addressLine1 | string | Example |
data.addressLine2 | string | Example |
data.city | string | Example |
data.state | string | Example |
data.postalCode | string | Example |
data.portalAccess | boolean | Example |
data.assignmentUpdates | boolean | Example |
data.serviceReminders | boolean | Example |
data.receiveEmail | boolean | Example |
data.receiveSms | boolean | Example |
data.receiveInApp | boolean | Example |
data.profileShareWithinOrganization | boolean | Example |
data.isPublished | boolean | Example |
data.networkAccess | boolean | Example |
data.status | integer | Example |
data.priority | integer | Example |
data.communicationModes | array of integer | |
data.hearingStatus | 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 'clients: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 |
422 Validation failed
Validation error - Missing or invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified consumer does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
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": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |