API reference › Providers

Get popup details of a service provider

GET /v1/service-provider/{id}/popup-details

Scope
providers:read

Fetches detailed popup information about a service provider including profile, skills, preferences, rates, availability, assignment-specific location type, etc.

Parameters

Path parameters

NameTypeDescription
id requiredstring

The unique ID of the service provider (e.g., SPR-JVI5GD)

Example SPR-JVI5GD.

Query parameters

NameTypeDescription
assignmentIdstring

Optional assignment ID to retrieve assignment-specific locationType (e.g., ASG-LVMXVD)

Example ASG-LVMXVD.

shiftIdstring

Optional shift ID to retrieve shift-specific locationType (e.g., SFT-LVMXVD). Mutually exclusive with assignmentId.

Example SFT-LVMXVD.

isFromPortalboolean

Whether this is being requested from a portal (client/consumer/provider) rather than the admin app. Changes the wording of recurring-assignment acceptance status and hides some admin-only fields.

Example false.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/service-provider/{id}/popup-details" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Successful response with service provider details

Successful response with service provider details

JSON
{
  "success": true,
  "message": "Service Provider details fetched successfully!",
  "data": {
    "id": "SPR-JVI5GD",
    "name": "John",
    "email": "john.doe@example.com",
    "countryCode": "+1",
    "phone": "9888888888",
    "logo": "https://fido-devserver.s3.us-east-1.amazonaws.comasas",
    "phoneType": "sms_and_voice",
    "timezone": "US",
    "genderPreference": "Male",
    "role": "staff",
    "status": 1,
    "locationType": "on-site",
    "serviceType": "ASL",
    "serviceProviderType": "Deaf",
    "isFavorite": false,
    "hearingStatus": "string",
    "networkAccess": false,
    "employmentStatus": "string",
    "skills": [
      {
        "id": 2,
        "label": "Advanced"
      }
    ],
    "certifications": [
      {
        "id": 1,
        "label": "NIC"
      }
    ],
    "clearances": [
      {
        "id": 1,
        "label": "HIPPA"
      }
    ],
    "specializations": [
      {
        "id": 1,
        "label": "Legal"
      }
    ],
    "availability": [
      {
        "shift_type": "first",
        "startDateTime": "2025-07-30 08:43:31",
        "endDateTime": "2025-07-31 08:43:31",
        "bufferBeforeMinutes": 1,
        "bufferAfterMinutes": 1
      }
    ],
    "rates": [
      {
        "rateType": "Standard",
        "rate": "10.00",
        "assignment": true,
        "shift": false,
        "unit": "hour",
        "minimumDuration": 1
      }
    ],
    "restrictedClients": [
      {
        "id": "CLI-123456",
        "label": "Client Name",
        "image": "https://example.com/image.jpg"
      }
    ],
    "restrictedConsumers": [
      null
    ],
    "restrictedServiceProviders": [
      {
        "id": "SPR-N4MTEC",
        "label": "John2",
        "image": "https://fido-devserver.s3.us-east-1.amazonaws.comtest"
      }
    ],
    "preferredClients": [
      null
    ],
    "preferredConsumers": [
      {
        "id": "CSM-YJNDSQ",
        "label": "demo consumer",
        "image": "https://fido-devserver.s3.us-east-1.amazonaws.comdemo"
      }
    ],
    "preferredServiceProviders": [
      null
    ]
  }
}
Response fields (61)

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Service Provider details fetched successfully!.

dataobject (58 nested)

Nested fields

data 58 fields
FieldTypeDescription
data.idstring

Example SPR-JVI5GD.

data.namestring

Example John.

data.emailstring

Example john.doe@example.com.

data.countryCodestring

Example +1.

data.phonestring

Example 9888888888.

data.logostring (url)

Example https://fido-devserver.s3.us-east-1.amazonaws.comasas.

data.phoneTypestring or null

Example sms_and_voice.

data.timezonestring

Example US.

data.genderPreferencestring

Example Male.

data.rolestring

Example staff.

data.statusinteger

Example 1.

data.locationTypestring

Example on-site.

data.serviceTypestring

Example ASL.

data.serviceProviderTypestring

Example Deaf.

data.isFavoriteboolean

Example false.

data.hearingStatusstring or null
data.networkAccessboolean

Example false.

data.employmentStatusstring or null
data.skillsarray of object
data.skills[].idinteger

Example 2.

data.skills[].labelstring

Example Advanced.

data.certificationsarray of object
data.certifications[].idinteger

Example 1.

data.certifications[].labelstring

Example NIC.

data.clearancesarray of object
data.clearances[].idinteger

Example 1.

data.clearances[].labelstring

Example HIPPA.

data.specializationsarray of object
data.specializations[].idinteger

Example 1.

data.specializations[].labelstring

Example Legal.

data.availabilityarray of object
data.availability[].shift_typestring

Example first.

data.availability[].startDateTimestring (date-time)

Example 2025-07-30 08:43:31.

data.availability[].endDateTimestring (date-time)

Example 2025-07-31 08:43:31.

data.availability[].bufferBeforeMinutesinteger or null

Example 1.

data.availability[].bufferAfterMinutesinteger or null

Example 1.

data.ratesarray of object
data.rates[].rateTypestring

Example Standard.

data.rates[].ratestring

Example 10.00.

data.rates[].assignmentboolean

Example true.

data.rates[].shiftboolean

Example false.

data.rates[].unitstring

Example hour.

data.rates[].minimumDurationinteger

Example 1.

data.restrictedClientsarray of object
data.restrictedClients[].idstring

Example CLI-123456.

data.restrictedClients[].labelstring

Example Client Name.

data.restrictedClients[].imagestring (url)

Example https://example.com/image.jpg.

data.restrictedConsumersarray of any
data.restrictedServiceProvidersarray of object
data.restrictedServiceProviders[].idstring

Example SPR-N4MTEC.

data.restrictedServiceProviders[].labelstring

Example John2.

data.restrictedServiceProviders[].imagestring (url)

Example https://fido-devserver.s3.us-east-1.amazonaws.comtest.

data.preferredClientsarray of any
data.preferredConsumersarray of object
data.preferredConsumers[].idstring

Example CSM-YJNDSQ.

data.preferredConsumers[].labelstring

Example demo consumer.

data.preferredConsumers[].imagestring (url)

Example https://fido-devserver.s3.us-east-1.amazonaws.comdemo.

data.preferredServiceProvidersarray of any
401 Not signed in

Missing, invalid or expired API key.

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 'providers: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 'providers: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

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": "Exception details here"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Exception details here.