API reference › Providers

Create a service provider

POST /v1/providers

Scope
providers:write
Roles
admin, scheduler

Creates a provider in this organization. Rates & Billing fields (rates, single rates, admin fee, billing and cancellation terms) need Finance Write: without it they are left out and the new record takes the organization's.

Parameters

None of its own.

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

Request body required

81 top-level fields; 34 hold nested fields, listed below.

FieldTypeDescription
name requiredstring

max length 255. Example Sam Rivera.

email requiredstring (email)

Unique among this organization's users.

max length 255. Example sam@example.test.

descriptionstring or null

min length 5, max length 2000.

logostring (binary) or null

jpg, jpeg or png, max 2 MB.

isPublishedboolean or null

Example true.

statusobject (2 nested)

Required when published.

priorityobject (2 nested)
rolesarray of object or null (3 nested)
serviceProviderRoleobject (2 nested)

Required when published. id is individual or agency.

employmentStatusstring or null

Required when published.

One of: full_time, part_time, contractor.

employmentStartDatestring (date) or null

Required when published.

employmentEndDatestring (date) or null

On or after employmentStartDate.

genderobject (2 nested)

Required when published for an individual provider.

dateOfBirthstring (date) or null

Optional.

hearingStatusobject (2 nested)

Required when published for an individual provider.

portalAccessboolean or null

Let the provider sign in to the provider portal.

networkAccessboolean or null

Share the provider with the Fido network.

enableCalendarIntegrationboolean or null
countryCodestring or null

max length 5. Example +1.

phonestring or null

Required when published unless videoPhone is sent, and when receiveSms is true.

max length 20. Example 2025550101.

phoneTypestring or null

One of: sms_and_voice, voice_only.

phoneExtensionstring or null

max length 10.

videoPhoneCountryCodestring or null

max length 5. Example +1.

videoPhonestring or null

max length 20.

userPreferredarray of object or null (2 nested)

Users this provider prefers.

userRestrictedarray of object or null (2 nested)

Users restricted from this provider.

clientRestrictedarray of object or null (2 nested)

Client users restricted from this provider.

consumerRestrictedarray of object or null (2 nested)

Consumer users restricted from this provider.

allowClientsToBroadcastImmediatelyboolean or null

Requests for this provider broadcast without scheduler review.

addressLine1string or null

Optional.

max length 255.

addressLine2string or null

max length 255.

citystring or null

Required when published.

max length 100.

stateobject (2 nested)

Required when published.

postalCodestring or null

Optional. 12345 or 12345-6789.

Example 78759.

assignmentRequestboolean or null

Notification preference.

assignmentUpdatesboolean or null

Notification preference.

serviceRemindersboolean or null

Notification preference.

receiveEmailboolean or null

Notification preference.

receiveSmsboolean or null

Notification preference.

receiveInAppboolean or null

Notification preference.

profileShareWithinOrganizationboolean or null
defaultServicesarray of object or null (8 nested)

Service type and provider type pairs the provider delivers. Each pair must be unique.

providerQualificationsarray of object or null (12 nested)

Certifications held, per service type and provider type.

clearancesarray of object or null (7 nested)

One entry per clearance; serviceType holds the clearance.

certificationsarray of object or null (7 nested)

Legacy flat list; serviceType holds the certification. The form sends providerQualifications instead.

specializationsarray of object or null (2 nested)
skillsobject (2 nested)
availabilityarray of object or null (6 nested)

Weekly office availability.

vacationsarray of object or null (6 nested)

Time off. A vacation left out of an update is removed.

scheduleTypestring or null

Shape of dateTimeSlots.

One of: one_time, recurring, multi_day.

dateTimeSlotsarray of object or null (5 nested)
maxAssignmentsPerWeekinteger or null
maxAssignmentsPerDayinteger or null
bufferBeforeMinutesinteger or null

min 0, max 240.

bufferAfterMinutesinteger or null

min 0, max 240.

travelRadiusobject (2 nested)

Required when published.

preferredServiceLocationsobject (2 nested)

Required when published. id is onsite, remote or both.

timezonestring or null

Example America/Chicago.

defaultTimezonestring or null

Localization. Required when published.

Example America/Chicago.

defaultLanguageobject (2 nested)

Localization.

dateFormatobject (2 nested)

Localization. Required when published.

timeFormatstring or null

Localization. Required when published.

startOfWeekobject (2 nested)

Localization.

startOfDaystring or null

Localization.

Example 08:00.

endOfDaystring or null

Localization.

Example 18:00.

restrictedClientsarray of object or null (2 nested)
restrictedConsumersarray of object or null (2 nested)
restrictedServiceProvidersarray of object or null (2 nested)
preferredClientsarray of object or null (2 nested)

Must not overlap restrictedClients.

preferredConsumersarray of object or null (2 nested)

Must not overlap restrictedConsumers.

preferredServiceProvidersarray of object or null (2 nested)

Must not overlap restrictedServiceProviders.

enableCustomRatesboolean or null

Use the provider's own rates. Makes rates required.

ratesarray of object or null (24 nested)
singleRatesarray of object or null (12 nested)
adminFeenumber or null
adminFeeTypestring or null

One of: assignment, shift, both.

providerAdminFeeMethodstring or null

One of: flat, percentage.

internalNotesstring or null
documentsarray of object or null (9 nested)

pdf, doc, docx, xls, xlsx, csv, png or jpg, max 2 MB each.

customFieldsobject or null

Custom field values keyed by field id.

externalCustomFieldsobject or null

Values for the external custom fields, keyed by field id.

Nested fields

status 2 fields
FieldTypeDescription
status.idinteger or string

Example 1.

status.labelstring or null

Example Example.

priority 2 fields
FieldTypeDescription
priority.idinteger or string

Example 1.

priority.labelstring or null

Example Example.

roles 3 fields
FieldTypeDescription
roles[].idinteger or null

Role id. Resolved from slug when omitted.

Example 3.

roles[].slugstring

Example consumer.

roles[].enabledboolean

Example true.

serviceProviderRole 2 fields
FieldTypeDescription
serviceProviderRole.idinteger or string

Example 1.

serviceProviderRole.labelstring or null

Example Example.

gender 2 fields
FieldTypeDescription
gender.idinteger or string

Example 1.

gender.labelstring or null

Example Example.

hearingStatus 2 fields
FieldTypeDescription
hearingStatus.idinteger or string

Example 1.

hearingStatus.labelstring or null

Example Example.

userPreferred 2 fields
FieldTypeDescription
userPreferred[].idinteger or string

Example 1.

userPreferred[].labelstring or null

Example Example.

userRestricted 2 fields
FieldTypeDescription
userRestricted[].idinteger or string

Example 1.

userRestricted[].labelstring or null

Example Example.

clientRestricted 2 fields
FieldTypeDescription
clientRestricted[].idinteger or string

Example 1.

clientRestricted[].labelstring or null

Example Example.

consumerRestricted 2 fields
FieldTypeDescription
consumerRestricted[].idinteger or string

Example 1.

consumerRestricted[].labelstring or null

Example Example.

state 2 fields
FieldTypeDescription
state.idinteger or string

Example 1.

state.labelstring or null

Example Example.

defaultServices 8 fields
FieldTypeDescription
defaultServices[].idinteger or null
defaultServices[].isDefaultboolean or null
defaultServices[].serviceTypeobject
defaultServices[].serviceType.idinteger or string

Example 1.

defaultServices[].serviceType.labelstring or null

Example Example.

defaultServices[].serviceProviderTypeobject
defaultServices[].serviceProviderType.idinteger or string

Example 1.

defaultServices[].serviceProviderType.labelstring or null

Example Example.

providerQualifications 12 fields
FieldTypeDescription
providerQualifications[].idinteger or null
providerQualifications[].isDefaultboolean or null
providerQualifications[].serviceTypeobject or array of object

One {id, label} or a list.

providerQualifications[].serviceProviderTypeobject or array of object

One {id, label} or a list.

providerQualifications[].certificationarray of object
providerQualifications[].certification[].idinteger or null

Existing row to keep or update.

providerQualifications[].certification[].serviceTypeobject

The certification or clearance itself.

providerQualifications[].certification[].serviceType.idinteger or string

Example 1.

providerQualifications[].certification[].serviceType.labelstring or null

Example Example.

providerQualifications[].certification[].startDatestring (date) or null

Issue date. Required for a clearance.

providerQualifications[].certification[].endDatestring (date) or null

Expiration date, after startDate. Required when the certification or clearance has expiration tracking on.

providerQualifications[].certification[].filestring (binary) or null

Proof document, max 2 MB. Required when the certification or clearance requires an upload.

clearances 7 fields
FieldTypeDescription
clearances[].idinteger or null

Existing row to keep or update.

clearances[].serviceTypeobject

The certification or clearance itself.

clearances[].serviceType.idinteger or string

Example 1.

clearances[].serviceType.labelstring or null

Example Example.

clearances[].startDatestring (date) or null

Issue date. Required for a clearance.

clearances[].endDatestring (date) or null

Expiration date, after startDate. Required when the certification or clearance has expiration tracking on.

clearances[].filestring (binary) or null

Proof document, max 2 MB. Required when the certification or clearance requires an upload.

certifications 7 fields
FieldTypeDescription
certifications[].idinteger or null

Existing row to keep or update.

certifications[].serviceTypeobject

The certification or clearance itself.

certifications[].serviceType.idinteger or string

Example 1.

certifications[].serviceType.labelstring or null

Example Example.

certifications[].startDatestring (date) or null

Issue date. Required for a clearance.

certifications[].endDatestring (date) or null

Expiration date, after startDate. Required when the certification or clearance has expiration tracking on.

certifications[].filestring (binary) or null

Proof document, max 2 MB. Required when the certification or clearance requires an upload.

specializations 2 fields
FieldTypeDescription
specializations[].idinteger or string

Example 1.

specializations[].labelstring or null

Example Example.

skills 2 fields
FieldTypeDescription
skills.idinteger or string

Example 1.

skills.labelstring or null

Example Example.

availability 6 fields
FieldTypeDescription
availability[].daystring

Example monday.

availability[].isAvailableboolean

Example true.

availability[].slotsarray of object
availability[].slots[].idinteger or null
availability[].slots[].startTimestring

Example 09:00:00.

availability[].slots[].endTimestring

Example 17:00:00.

vacations 6 fields
FieldTypeDescription
vacations[].idinteger or null
vacations[].reasonstring or null
vacations[].startDatestring (date)

Example 2025-07-01.

vacations[].endDatestring (date)

Example 2025-07-04.

vacations[].startTimestring

Example 00:00:00.

vacations[].endTimestring

Example 23:59:00.

dateTimeSlots 5 fields
FieldTypeDescription
dateTimeSlots[].startDatestring (date)
dateTimeSlots[].endDatestring (date)
dateTimeSlots[].timeSlotsarray of object or null
dateTimeSlots[].timeSlots[].startTimestring

Example 09:00:00.

dateTimeSlots[].timeSlots[].endTimestring

Example 17:00:00.

travelRadius 2 fields
FieldTypeDescription
travelRadius.idinteger or string

Example 1.

travelRadius.labelstring or null

Example Example.

preferredServiceLocations 2 fields
FieldTypeDescription
preferredServiceLocations.idinteger or string

Example 1.

preferredServiceLocations.labelstring or null

Example Example.

defaultLanguage 2 fields
FieldTypeDescription
defaultLanguage.idinteger or string

Example 1.

defaultLanguage.labelstring or null

Example Example.

dateFormat 2 fields
FieldTypeDescription
dateFormat.idinteger or string

Example 1.

dateFormat.labelstring or null

Example Example.

startOfWeek 2 fields
FieldTypeDescription
startOfWeek.idinteger or string

Example 1.

startOfWeek.labelstring or null

Example Example.

restrictedClients 2 fields
FieldTypeDescription
restrictedClients[].idinteger or string

Example 1.

restrictedClients[].labelstring or null

Example Example.

restrictedConsumers 2 fields
FieldTypeDescription
restrictedConsumers[].idinteger or string

Example 1.

restrictedConsumers[].labelstring or null

Example Example.

restrictedServiceProviders 2 fields
FieldTypeDescription
restrictedServiceProviders[].idinteger or string

Example 1.

restrictedServiceProviders[].labelstring or null

Example Example.

preferredClients 2 fields
FieldTypeDescription
preferredClients[].idinteger or string

Example 1.

preferredClients[].labelstring or null

Example Example.

preferredConsumers 2 fields
FieldTypeDescription
preferredConsumers[].idinteger or string

Example 1.

preferredConsumers[].labelstring or null

Example Example.

preferredServiceProviders 2 fields
FieldTypeDescription
preferredServiceProviders[].idinteger or string

Example 1.

preferredServiceProviders[].labelstring or null

Example Example.

rates 24 fields
FieldTypeDescription
rates[].idinteger or null

Example 31.

rates[].serviceTypeobject
rates[].serviceType.idinteger or string

Example 1.

rates[].serviceType.labelstring or null

Example Example.

rates[].serviceProviderTypeobject
rates[].serviceProviderType.idinteger or string

Example 1.

rates[].serviceProviderType.labelstring or null

Example Example.

rates[].siteTypeobject
rates[].siteType.idinteger or string

Example 1.

rates[].siteType.labelstring or null

Example Example.

rates[].rateTypeobject
rates[].rateType.idinteger or string

Example 1.

rates[].rateType.labelstring or null

Example Example.

rates[].certificationobject
rates[].certification.idinteger or string

Example 1.

rates[].certification.labelstring or null

Example Example.

rates[].specializationobject
rates[].specialization.idinteger or string

Example 1.

rates[].specialization.labelstring or null

Example Example.

rates[].assignmentboolean

The rate applies to assignments.

Example true.

rates[].shiftboolean

The rate applies to shifts.

Example false.

rates[].ratenumber (float)

Example 45.

rates[].unitstring or null

Example hour.

rates[].minimumDurationnumber or null

Example 2.

singleRates 12 fields
FieldTypeDescription
singleRates[].serviceTypeobject
singleRates[].serviceType.idinteger or string

Example 1.

singleRates[].serviceType.labelstring or null

Example Example.

singleRates[].serviceProviderTypeobject
singleRates[].serviceProviderType.idinteger or string

Example 1.

singleRates[].serviceProviderType.labelstring or null

Example Example.

singleRates[].assignmentEnabledboolean

Example true.

singleRates[].assignmentRatenumber (float) or null

Example 50.

singleRates[].assignmentRateUnitstring or null

Example hour.

singleRates[].shiftEnabledboolean

Example false.

singleRates[].shiftRatenumber (float) or null

Example 40.

singleRates[].shiftRateUnitstring or null

Example hour.

documents 9 fields
FieldTypeDescription
documents[].idinteger or null

Example 12.

documents[].filestring (binary) or null

The uploaded file. Omit when only the categories or tags of an existing document change.

documents[].fileNamestring or null

Example intake-form.pdf.

documents[].categoriesarray of object

Existing categories by id, or new ones by label.

documents[].categories[].idinteger or string

Example 1.

documents[].categories[].labelstring or null

Example Example.

documents[].tagsarray of object

Existing tags by id, or new ones by label.

documents[].tags[].idinteger or string

Example 1.

documents[].tags[].labelstring or null

Example Example.

Example

JSON
{
  "name": "Sam Rivera",
  "email": "sam@example.test",
  "description": "string",
  "logo": "string",
  "isPublished": true,
  "status": {
    "id": 1,
    "label": "Example"
  },
  "priority": {
    "id": 1,
    "label": "Example"
  },
  "roles": [
    {
      "id": 3,
      "slug": "consumer",
      "enabled": true
    }
  ],
  "serviceProviderRole": {
    "id": 1,
    "label": "Example"
  },
  "employmentStatus": "full_time",
  "employmentStartDate": "string",
  "employmentEndDate": "string",
  "gender": {
    "id": 1,
    "label": "Example"
  },
  "dateOfBirth": "string",
  "hearingStatus": {
    "id": 1,
    "label": "Example"
  },
  "portalAccess": true,
  "networkAccess": true,
  "enableCalendarIntegration": true,
  "countryCode": "+1",
  "phone": "2025550101",
  "phoneType": "sms_and_voice",
  "phoneExtension": "string",
  "videoPhoneCountryCode": "+1",
  "videoPhone": "string",
  "userPreferred": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "userRestricted": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "clientRestricted": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "consumerRestricted": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "allowClientsToBroadcastImmediately": true,
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": {
    "id": 1,
    "label": "Example"
  },
  "postalCode": "78759",
  "assignmentRequest": true,
  "assignmentUpdates": true,
  "serviceReminders": true,
  "receiveEmail": true,
  "receiveSms": true,
  "receiveInApp": true,
  "profileShareWithinOrganization": true,
  "defaultServices": [
    {
      "id": 0,
      "isDefault": true,
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "serviceProviderType": {
        "id": 1,
        "label": "Example"
      }
    }
  ],
  "providerQualifications": [
    {
      "id": 0,
      "isDefault": true,
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "serviceProviderType": {
        "id": 1,
        "label": "Example"
      },
      "certification": [
        {
          "id": 0,
          "serviceType": {
            "id": 1,
            "label": "Example"
          },
          "startDate": "string",
          "endDate": "string",
          "file": "string"
        }
      ]
    }
  ],
  "clearances": [
    {
      "id": 0,
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "startDate": "string",
      "endDate": "string",
      "file": "string"
    }
  ],
  "certifications": [
    {
      "id": 0,
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "startDate": "string",
      "endDate": "string",
      "file": "string"
    }
  ],
  "specializations": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "skills": {
    "id": 1,
    "label": "Example"
  },
  "availability": [
    {
      "day": "monday",
      "isAvailable": true,
      "slots": [
        {
          "id": 0,
          "startTime": "09:00:00",
          "endTime": "17:00:00"
        }
      ]
    }
  ],
  "vacations": [
    {
      "id": 0,
      "reason": "string",
      "startDate": "2025-07-01",
      "endDate": "2025-07-04",
      "startTime": "00:00:00",
      "endTime": "23:59:00"
    }
  ],
  "scheduleType": "one_time",
  "dateTimeSlots": [
    {
      "startDate": "string",
      "endDate": "string",
      "timeSlots": [
        {
          "startTime": "09:00:00",
          "endTime": "17:00:00"
        }
      ]
    }
  ],
  "maxAssignmentsPerWeek": 0,
  "maxAssignmentsPerDay": 0,
  "bufferBeforeMinutes": 0,
  "bufferAfterMinutes": 0,
  "travelRadius": {
    "id": 1,
    "label": "Example"
  },
  "preferredServiceLocations": {
    "id": 1,
    "label": "Example"
  },
  "timezone": "America/Chicago",
  "defaultTimezone": "America/Chicago",
  "defaultLanguage": {
    "id": 1,
    "label": "Example"
  },
  "dateFormat": {
    "id": 1,
    "label": "Example"
  },
  "timeFormat": "string",
  "startOfWeek": {
    "id": 1,
    "label": "Example"
  },
  "startOfDay": "08:00",
  "endOfDay": "18:00",
  "restrictedClients": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "restrictedConsumers": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "restrictedServiceProviders": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "preferredClients": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "preferredConsumers": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "preferredServiceProviders": [
    {
      "id": 1,
      "label": "Example"
    }
  ],
  "enableCustomRates": true,
  "rates": [
    {
      "id": 31,
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "serviceProviderType": {
        "id": 1,
        "label": "Example"
      },
      "siteType": {
        "id": 1,
        "label": "Example"
      },
      "rateType": {
        "id": 1,
        "label": "Example"
      },
      "certification": {
        "id": 1,
        "label": "Example"
      },
      "specialization": {
        "id": 1,
        "label": "Example"
      },
      "assignment": true,
      "shift": false,
      "rate": 45,
      "unit": "hour",
      "minimumDuration": 2
    }
  ],
  "singleRates": [
    {
      "serviceType": {
        "id": 1,
        "label": "Example"
      },
      "serviceProviderType": {
        "id": 1,
        "label": "Example"
      },
      "assignmentEnabled": true,
      "assignmentRate": 50,
      "assignmentRateUnit": "hour",
      "shiftEnabled": false,
      "shiftRate": 40,
      "shiftRateUnit": "hour"
    }
  ],
  "adminFee": 0,
  "adminFeeType": "assignment",
  "providerAdminFeeMethod": "flat",
  "internalNotes": "string",
  "documents": [
    {
      "id": 12,
      "file": "string",
      "fileName": "intake-form.pdf",
      "categories": [
        {
          "id": 1,
          "label": "Example"
        }
      ],
      "tags": [
        {
          "id": 1,
          "label": "Example"
        }
      ]
    }
  ],
  "customFields": {},
  "externalCustomFields": {}
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/providers" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sam Rivera","email":"sam@example.test","description":"string","logo":"string","isPublished":true,"status":{"id":1,"label":"Example"},"priority":{"id":1,"label":"Example"},"roles":[{"id":3,"slug":"consumer","enabled":true}],"serviceProviderRole":{"id":1,"label":"Example"},"employmentStatus":"full_time","employmentStartDate":"string","employmentEndDate":"string","gender":{"id":1,"label":"Example"},"dateOfBirth":"string","hearingStatus":{"id":1,"label":"Example"},"portalAccess":true,"networkAccess":true,"enableCalendarIntegration":true,"countryCode":"+1","phone":"2025550101","phoneType":"sms_and_voice","phoneExtension":"string","videoPhoneCountryCode":"+1","videoPhone":"string","userPreferred":[{"id":1,"label":"Example"}],"userRestricted":[{"id":1,"label":"Example"}],"clientRestricted":[{"id":1,"label":"Example"}],"consumerRestricted":[{"id":1,"label":"Example"}],"allowClientsToBroadcastImmediately":true,"addressLine1":"string","addressLine2":"string","city":"string","state":{"id":1,"label":"Example"},"postalCode":"78759","assignmentRequest":true,"assignmentUpdates":true,"serviceReminders":true,"receiveEmail":true,"receiveSms":true,"receiveInApp":true,"profileShareWithinOrganization":true,"defaultServices":[{"id":0,"isDefault":true,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"}}],"providerQualifications":[{"id":0,"isDefault":true,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"certification":[{"id":0,"serviceType":{"id":1,"label":"Example"},"startDate":"string","endDate":"string","file":"string"}]}],"clearances":[{"id":0,"serviceType":{"id":1,"label":"Example"},"startDate":"string","endDate":"string","file":"string"}],"certifications":[{"id":0,"serviceType":{"id":1,"label":"Example"},"startDate":"string","endDate":"string","file":"string"}],"specializations":[{"id":1,"label":"Example"}],"skills":{"id":1,"label":"Example"},"availability":[{"day":"monday","isAvailable":true,"slots":[{"id":0,"startTime":"09:00:00","endTime":"17:00:00"}]}],"vacations":[{"id":0,"reason":"string","startDate":"2025-07-01","endDate":"2025-07-04","startTime":"00:00:00","endTime":"23:59:00"}],"scheduleType":"one_time","dateTimeSlots":[{"startDate":"string","endDate":"string","timeSlots":[{"startTime":"09:00:00","endTime":"17:00:00"}]}],"maxAssignmentsPerWeek":0,"maxAssignmentsPerDay":0,"bufferBeforeMinutes":0,"bufferAfterMinutes":0,"travelRadius":{"id":1,"label":"Example"},"preferredServiceLocations":{"id":1,"label":"Example"},"timezone":"America/Chicago","defaultTimezone":"America/Chicago","defaultLanguage":{"id":1,"label":"Example"},"dateFormat":{"id":1,"label":"Example"},"timeFormat":"string","startOfWeek":{"id":1,"label":"Example"},"startOfDay":"08:00","endOfDay":"18:00","restrictedClients":[{"id":1,"label":"Example"}],"restrictedConsumers":[{"id":1,"label":"Example"}],"restrictedServiceProviders":[{"id":1,"label":"Example"}],"preferredClients":[{"id":1,"label":"Example"}],"preferredConsumers":[{"id":1,"label":"Example"}],"preferredServiceProviders":[{"id":1,"label":"Example"}],"enableCustomRates":true,"rates":[{"id":31,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"siteType":{"id":1,"label":"Example"},"rateType":{"id":1,"label":"Example"},"certification":{"id":1,"label":"Example"},"specialization":{"id":1,"label":"Example"},"assignment":true,"shift":false,"rate":45,"unit":"hour","minimumDuration":2}],"singleRates":[{"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"assignmentEnabled":true,"assignmentRate":50,"assignmentRateUnit":"hour","shiftEnabled":false,"shiftRate":40,"shiftRateUnit":"hour"}],"adminFee":0,"adminFeeType":"assignment","providerAdminFeeMethod":"flat","internalNotes":"string","documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"customFields":{},"externalCustomFields":{}}'

Try it

Responses

201 Service provider created

Service provider created

JSON
{
  "success": true,
  "message": "Service provider created successfully.",
  "data": {
    "id": "SPR-H6OUI3"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service provider created successfully..

dataobject
data.idstring

Example SPR-H6OUI3.

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:write' 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:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

JSON
{
  "status": "error",
  "message": "Unable to save. Please check the highlighted fields",
  "errors": {
    "name": [
      "Please enter a name."
    ],
    "email": [
      "The email has already been taken."
    ]
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsobject

Field name to its messages. Nested keys are collapsed onto the field the form renders.

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

Unexpected error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
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, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .