API reference › Consumers

Retrieve specific tab details of a consumer

GET /v1/consumers/{consumer}/tab/{tab}

Scope
consumers:read
Roles
admin, scheduler

Fetches the details for a specific tab within a consumer, based on the provided consumer ID and tab identifier.

Parameters

Path parameters

NameTypeDescription
consumer requiredstring

Unique identifier of the consumer

Example CSM-PMJKT2.

tab requiredstring

The tab to fetch. rates_billing is accepted but has no consumer view, so it returns data: null.

One of: general, localizations, requirement_preferences, rates_billing, document_notes, associated_clients, assignmentStats. Example general.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/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

JSON
{
  "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": {
      "id": 1,
      "label": "Texas"
    },
    "postalCode": "78759",
    "gender": {
      "id": "female",
      "label": "Female"
    },
    "dateOfBirth": "1990-04-12",
    "portalAccess": false,
    "inviteState": "not_invited",
    "inviteExpiresAt": null,
    "enableCalendarIntegration": false,
    "assignmentUpdates": false,
    "serviceReminders": false,
    "receiveEmail": false,
    "receiveSms": false,
    "receiveInApp": false,
    "profileShareWithinOrganization": false,
    "isPublished": true,
    "networkAccess": false,
    "status": {
      "id": 1,
      "label": "Active"
    },
    "priority": {
      "id": 1,
      "label": "High"
    },
    "consumerType": {
      "id": 1,
      "label": "Individual"
    },
    "communicationModes": [
      {
        "id": 1,
        "label": "ASL (American Sign Language)"
      }
    ],
    "hearingStatus": {
      "id": "deaf",
      "label": "Deaf"
    },
    "customFields": [],
    "externalCustomFields": [],
    "roles": []
  }
}
Response fields (54)

3 top-level fields; 1 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Consumer details retrieved!.

dataobject (51 nested)

Nested fields

data 51 fields
FieldTypeDescription
data.idstring

Example CSM-PMJKT2.

data.namestring

Example ABCD.

data.descriptionstring

Example Test description.

data.emailstring

Example user@example.com.

data.logostring or null
data.countryCodestring

Example +1.

data.phonestring

Example 9888888888.

data.phoneTypestring

Example sms_and_voice.

data.videoPhoneCountryCodestring

Example +1.

data.videoPhonestring

Example 9888888888.

data.addressLine1string

Example 101 Street.

data.addressLine2string

Example Beagle Run.

data.citystring

Example Austin.

data.stateobject
data.state.idinteger

Example 1.

data.state.labelstring

Example Texas.

data.postalCodestring

Example 78759.

data.genderobject
data.gender.idstring

Example female.

data.gender.labelstring

Example Female.

data.dateOfBirthstring (date)

Example 1990-04-12.

data.portalAccessboolean

Example false.

data.inviteStatestring

Example not_invited.

data.inviteExpiresAtstring or null
data.enableCalendarIntegrationboolean

Example false.

data.assignmentUpdatesboolean

Example false.

data.serviceRemindersboolean

Example false.

data.receiveEmailboolean

Example false.

data.receiveSmsboolean

Example false.

data.receiveInAppboolean

Example false.

data.profileShareWithinOrganizationboolean

Example false.

data.isPublishedboolean

Example true.

data.networkAccessboolean

Example false.

data.statusobject
data.status.idinteger

Example 1.

data.status.labelstring

Example Active.

data.priorityobject
data.priority.idinteger

Example 1.

data.priority.labelstring

Example High.

data.consumerTypeobject
data.consumerType.idinteger

Example 1.

data.consumerType.labelstring

Example Individual.

data.communicationModesarray of object
data.communicationModes[].idinteger

Example 1.

data.communicationModes[].labelstring

Example ASL (American Sign Language).

data.hearingStatusobject
data.hearingStatus.idstring

Example deaf.

data.hearingStatus.labelstring

Example Deaf.

data.customFieldsarray of object
data.externalCustomFieldsarray of object
data.rolesarray of object
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 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..