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.
| Field | Type | Description |
|---|---|---|
name required | string | max length 255. Example |
email required | string (email) | Unique among this organization's users. max length 255. Example |
description | string or null | min length 5, max length 2000. |
logo | string (binary) or null | jpg, jpeg or png, max 2 MB. |
isPublished | boolean or null | Example |
status | object (2 nested) | Required when published. |
priority | object (2 nested) | |
roles | array of object or null (3 nested) | |
serviceProviderRole | object (2 nested) | Required when published. id is individual or agency. |
employmentStatus | string or null | Required when published. One of: |
employmentStartDate | string (date) or null | Required when published. |
employmentEndDate | string (date) or null | On or after employmentStartDate. |
gender | object (2 nested) | Required when published for an individual provider. |
dateOfBirth | string (date) or null | Optional. |
hearingStatus | object (2 nested) | Required when published for an individual provider. |
portalAccess | boolean or null | Let the provider sign in to the provider portal. |
networkAccess | boolean or null | Share the provider with the Fido network. |
enableCalendarIntegration | boolean or null | |
countryCode | string or null | max length 5. Example |
phone | string or null | Required when published unless videoPhone is sent, and when receiveSms is true. max length 20. Example |
phoneType | string or null | One of: |
phoneExtension | string or null | max length 10. |
videoPhoneCountryCode | string or null | max length 5. Example |
videoPhone | string or null | max length 20. |
userPreferred | array of object or null (2 nested) | Users this provider prefers. |
userRestricted | array of object or null (2 nested) | Users restricted from this provider. |
clientRestricted | array of object or null (2 nested) | Client users restricted from this provider. |
consumerRestricted | array of object or null (2 nested) | Consumer users restricted from this provider. |
allowClientsToBroadcastImmediately | boolean or null | Requests for this provider broadcast without scheduler review. |
addressLine1 | string or null | Optional. max length 255. |
addressLine2 | string or null | max length 255. |
city | string or null | Required when published. max length 100. |
state | object (2 nested) | Required when published. |
postalCode | string or null | Optional. 12345 or 12345-6789. Example |
assignmentRequest | boolean or null | Notification preference. |
assignmentUpdates | boolean or null | Notification preference. |
serviceReminders | boolean or null | Notification preference. |
receiveEmail | boolean or null | Notification preference. |
receiveSms | boolean or null | Notification preference. |
receiveInApp | boolean or null | Notification preference. |
profileShareWithinOrganization | boolean or null | |
defaultServices | array of object or null (8 nested) | Service type and provider type pairs the provider delivers. Each pair must be unique. |
providerQualifications | array of object or null (12 nested) | Certifications held, per service type and provider type. |
clearances | array of object or null (7 nested) | One entry per clearance; serviceType holds the clearance. |
certifications | array of object or null (7 nested) | Legacy flat list; serviceType holds the certification. The form sends providerQualifications instead. |
specializations | array of object or null (2 nested) | |
skills | object (2 nested) | |
availability | array of object or null (6 nested) | Weekly office availability. |
vacations | array of object or null (6 nested) | Time off. A vacation left out of an update is removed. |
scheduleType | string or null | Shape of dateTimeSlots. One of: |
dateTimeSlots | array of object or null (5 nested) | |
maxAssignmentsPerWeek | integer or null | |
maxAssignmentsPerDay | integer or null | |
bufferBeforeMinutes | integer or null | min 0, max 240. |
bufferAfterMinutes | integer or null | min 0, max 240. |
travelRadius | object (2 nested) | Required when published. |
preferredServiceLocations | object (2 nested) | Required when published. id is onsite, remote or both. |
timezone | string or null | Example |
defaultTimezone | string or null | Localization. Required when published. Example |
defaultLanguage | object (2 nested) | Localization. |
dateFormat | object (2 nested) | Localization. Required when published. |
timeFormat | string or null | Localization. Required when published. |
startOfWeek | object (2 nested) | Localization. |
startOfDay | string or null | Localization. Example |
endOfDay | string or null | Localization. Example |
restrictedClients | array of object or null (2 nested) | |
restrictedConsumers | array of object or null (2 nested) | |
restrictedServiceProviders | array of object or null (2 nested) | |
preferredClients | array of object or null (2 nested) | Must not overlap restrictedClients. |
preferredConsumers | array of object or null (2 nested) | Must not overlap restrictedConsumers. |
preferredServiceProviders | array of object or null (2 nested) | Must not overlap restrictedServiceProviders. |
enableCustomRates | boolean or null | Use the provider's own rates. Makes rates required. |
rates | array of object or null (24 nested) | |
singleRates | array of object or null (12 nested) | |
adminFee | number or null | |
adminFeeType | string or null | One of: |
providerAdminFeeMethod | string or null | One of: |
internalNotes | string or null | |
documents | array of object or null (9 nested) | pdf, doc, docx, xls, xlsx, csv, png or jpg, max 2 MB each. |
customFields | object or null | Custom field values keyed by field id. |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
Nested fields
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer or string | Example |
status.label | string or null | Example |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer or string | Example |
priority.label | string or null | Example |
roles 3 fields
| Field | Type | Description |
|---|---|---|
roles[].id | integer or null | Role id. Resolved from slug when omitted. Example |
roles[].slug | string | Example |
roles[].enabled | boolean | Example |
serviceProviderRole 2 fields
| Field | Type | Description |
|---|---|---|
serviceProviderRole.id | integer or string | Example |
serviceProviderRole.label | string or null | Example |
gender 2 fields
| Field | Type | Description |
|---|---|---|
gender.id | integer or string | Example |
gender.label | string or null | Example |
hearingStatus 2 fields
| Field | Type | Description |
|---|---|---|
hearingStatus.id | integer or string | Example |
hearingStatus.label | string or null | Example |
userPreferred 2 fields
| Field | Type | Description |
|---|---|---|
userPreferred[].id | integer or string | Example |
userPreferred[].label | string or null | Example |
userRestricted 2 fields
| Field | Type | Description |
|---|---|---|
userRestricted[].id | integer or string | Example |
userRestricted[].label | string or null | Example |
clientRestricted 2 fields
| Field | Type | Description |
|---|---|---|
clientRestricted[].id | integer or string | Example |
clientRestricted[].label | string or null | Example |
consumerRestricted 2 fields
| Field | Type | Description |
|---|---|---|
consumerRestricted[].id | integer or string | Example |
consumerRestricted[].label | string or null | Example |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer or string | Example |
state.label | string or null | Example |
defaultServices 8 fields
| Field | Type | Description |
|---|---|---|
defaultServices[].id | integer or null | |
defaultServices[].isDefault | boolean or null | |
defaultServices[].serviceType | object | |
defaultServices[].serviceType.id | integer or string | Example |
defaultServices[].serviceType.label | string or null | Example |
defaultServices[].serviceProviderType | object | |
defaultServices[].serviceProviderType.id | integer or string | Example |
defaultServices[].serviceProviderType.label | string or null | Example |
providerQualifications 12 fields
| Field | Type | Description |
|---|---|---|
providerQualifications[].id | integer or null | |
providerQualifications[].isDefault | boolean or null | |
providerQualifications[].serviceType | object or array of object | One {id, label} or a list. |
providerQualifications[].serviceProviderType | object or array of object | One {id, label} or a list. |
providerQualifications[].certification | array of object | |
providerQualifications[].certification[].id | integer or null | Existing row to keep or update. |
providerQualifications[].certification[].serviceType | object | The certification or clearance itself. |
providerQualifications[].certification[].serviceType.id | integer or string | Example |
providerQualifications[].certification[].serviceType.label | string or null | Example |
providerQualifications[].certification[].startDate | string (date) or null | Issue date. Required for a clearance. |
providerQualifications[].certification[].endDate | string (date) or null | Expiration date, after startDate. Required when the certification or clearance has expiration tracking on. |
providerQualifications[].certification[].file | string (binary) or null | Proof document, max 2 MB. Required when the certification or clearance requires an upload. |
clearances 7 fields
| Field | Type | Description |
|---|---|---|
clearances[].id | integer or null | Existing row to keep or update. |
clearances[].serviceType | object | The certification or clearance itself. |
clearances[].serviceType.id | integer or string | Example |
clearances[].serviceType.label | string or null | Example |
clearances[].startDate | string (date) or null | Issue date. Required for a clearance. |
clearances[].endDate | string (date) or null | Expiration date, after startDate. Required when the certification or clearance has expiration tracking on. |
clearances[].file | string (binary) or null | Proof document, max 2 MB. Required when the certification or clearance requires an upload. |
certifications 7 fields
| Field | Type | Description |
|---|---|---|
certifications[].id | integer or null | Existing row to keep or update. |
certifications[].serviceType | object | The certification or clearance itself. |
certifications[].serviceType.id | integer or string | Example |
certifications[].serviceType.label | string or null | Example |
certifications[].startDate | string (date) or null | Issue date. Required for a clearance. |
certifications[].endDate | string (date) or null | Expiration date, after startDate. Required when the certification or clearance has expiration tracking on. |
certifications[].file | string (binary) or null | Proof document, max 2 MB. Required when the certification or clearance requires an upload. |
specializations 2 fields
| Field | Type | Description |
|---|---|---|
specializations[].id | integer or string | Example |
specializations[].label | string or null | Example |
skills 2 fields
| Field | Type | Description |
|---|---|---|
skills.id | integer or string | Example |
skills.label | string or null | Example |
availability 6 fields
| Field | Type | Description |
|---|---|---|
availability[].day | string | Example |
availability[].isAvailable | boolean | Example |
availability[].slots | array of object | |
availability[].slots[].id | integer or null | |
availability[].slots[].startTime | string | Example |
availability[].slots[].endTime | string | Example |
vacations 6 fields
| Field | Type | Description |
|---|---|---|
vacations[].id | integer or null | |
vacations[].reason | string or null | |
vacations[].startDate | string (date) | Example |
vacations[].endDate | string (date) | Example |
vacations[].startTime | string | Example |
vacations[].endTime | string | Example |
dateTimeSlots 5 fields
| Field | Type | Description |
|---|---|---|
dateTimeSlots[].startDate | string (date) | |
dateTimeSlots[].endDate | string (date) | |
dateTimeSlots[].timeSlots | array of object or null | |
dateTimeSlots[].timeSlots[].startTime | string | Example |
dateTimeSlots[].timeSlots[].endTime | string | Example |
travelRadius 2 fields
| Field | Type | Description |
|---|---|---|
travelRadius.id | integer or string | Example |
travelRadius.label | string or null | Example |
preferredServiceLocations 2 fields
| Field | Type | Description |
|---|---|---|
preferredServiceLocations.id | integer or string | Example |
preferredServiceLocations.label | string or null | Example |
defaultLanguage 2 fields
| Field | Type | Description |
|---|---|---|
defaultLanguage.id | integer or string | Example |
defaultLanguage.label | string or null | Example |
dateFormat 2 fields
| Field | Type | Description |
|---|---|---|
dateFormat.id | integer or string | Example |
dateFormat.label | string or null | Example |
startOfWeek 2 fields
| Field | Type | Description |
|---|---|---|
startOfWeek.id | integer or string | Example |
startOfWeek.label | string or null | Example |
restrictedClients 2 fields
| Field | Type | Description |
|---|---|---|
restrictedClients[].id | integer or string | Example |
restrictedClients[].label | string or null | Example |
restrictedConsumers 2 fields
| Field | Type | Description |
|---|---|---|
restrictedConsumers[].id | integer or string | Example |
restrictedConsumers[].label | string or null | Example |
restrictedServiceProviders 2 fields
| Field | Type | Description |
|---|---|---|
restrictedServiceProviders[].id | integer or string | Example |
restrictedServiceProviders[].label | string or null | Example |
preferredClients 2 fields
| Field | Type | Description |
|---|---|---|
preferredClients[].id | integer or string | Example |
preferredClients[].label | string or null | Example |
preferredConsumers 2 fields
| Field | Type | Description |
|---|---|---|
preferredConsumers[].id | integer or string | Example |
preferredConsumers[].label | string or null | Example |
preferredServiceProviders 2 fields
| Field | Type | Description |
|---|---|---|
preferredServiceProviders[].id | integer or string | Example |
preferredServiceProviders[].label | string or null | Example |
rates 24 fields
| Field | Type | Description |
|---|---|---|
rates[].id | integer or null | Example |
rates[].serviceType | object | |
rates[].serviceType.id | integer or string | Example |
rates[].serviceType.label | string or null | Example |
rates[].serviceProviderType | object | |
rates[].serviceProviderType.id | integer or string | Example |
rates[].serviceProviderType.label | string or null | Example |
rates[].siteType | object | |
rates[].siteType.id | integer or string | Example |
rates[].siteType.label | string or null | Example |
rates[].rateType | object | |
rates[].rateType.id | integer or string | Example |
rates[].rateType.label | string or null | Example |
rates[].certification | object | |
rates[].certification.id | integer or string | Example |
rates[].certification.label | string or null | Example |
rates[].specialization | object | |
rates[].specialization.id | integer or string | Example |
rates[].specialization.label | string or null | Example |
rates[].assignment | boolean | The rate applies to assignments. Example |
rates[].shift | boolean | The rate applies to shifts. Example |
rates[].rate | number (float) | Example |
rates[].unit | string or null | Example |
rates[].minimumDuration | number or null | Example |
singleRates 12 fields
| Field | Type | Description |
|---|---|---|
singleRates[].serviceType | object | |
singleRates[].serviceType.id | integer or string | Example |
singleRates[].serviceType.label | string or null | Example |
singleRates[].serviceProviderType | object | |
singleRates[].serviceProviderType.id | integer or string | Example |
singleRates[].serviceProviderType.label | string or null | Example |
singleRates[].assignmentEnabled | boolean | Example |
singleRates[].assignmentRate | number (float) or null | Example |
singleRates[].assignmentRateUnit | string or null | Example |
singleRates[].shiftEnabled | boolean | Example |
singleRates[].shiftRate | number (float) or null | Example |
singleRates[].shiftRateUnit | string or null | Example |
documents 9 fields
| Field | Type | Description |
|---|---|---|
documents[].id | integer or null | Example |
documents[].file | string (binary) or null | The uploaded file. Omit when only the categories or tags of an existing document change. |
documents[].fileName | string or null | Example |
documents[].categories | array of object | Existing categories by |
documents[].categories[].id | integer or string | Example |
documents[].categories[].label | string or null | Example |
documents[].tags | array of object | Existing tags by |
documents[].tags[].id | integer or string | Example |
documents[].tags[].label | string or null | Example |
Example
{
"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
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
{
"success": true,
"message": "Service provider created successfully.",
"data": {
"id": "SPR-H6OUI3"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'providers:write' 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
{
"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)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | 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.
{
"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
Unexpected error
{
"success": false,
"message": "An unexpected error occurred — please try again.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator. |
code | string | Always empty: the server-error response carries no error code. Example |