search

Service providers

hashtag
Get a service provider

get

Retrieve a service provider by ID

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
serviceProviderIdstringRequiredPattern: [^\/#\?]+?
Responses
chevron-right
200Success
application/json
get
/api/service-providers/{serviceProviderId}
200Success

hashtag
Update a service provider

put

Update an existing service provider

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
serviceProviderIdstringRequiredPattern: [^\/#\?]+?
Body
idintegerOptional

The unique identifier of the service provider

Example: 1
firstNamestringOptional

The first name of the service provider

Example: JohnPattern: ^[a-zA-Z\s\-']+$
lastNamestringOptional

The last name of the service provider

Example: DoePattern: ^[a-zA-Z\s\-']+$
emailstring · emailOptional

The email address of the service provider

Example: [email protected]
mobilestringOptional

The mobile number of the service provider

Example: +1234567890
birthDateone ofOptional

The birth date of the service provider

Example: 1990-01-01
string · dateOptional
or
string · date-timeOptional
genderstring · enumOptional

The gender of the service provider

Example: MALEPossible values:
timeZonestringOptional

The time zone of the service provider

Example: UTCPattern: ^[A-Za-z_/+-]+$
activebooleanOptional

The active status of the service provider

Example: true
attributesstring · jsonOptional

Additional attributes of the service provider

Example: {}
rolestring · enumOptional

The role of the service provider

Example: CLIENT_MANAGERPossible values:
rolesstring[]Optional

The roles of the service provider

Default: []Example: ["role1","role2"]
subRolesinteger[]Optional

The sub-roles of the service provider

Default: []Example: [1,2]
onboardingStatusstringOptional

The onboarding status of the service provider

Example: completedPattern: ^[a-zA-Z0-9_-]+$
organizationobjectOptional

The organization of the service provider

Default: {}Example: {"id":1}
invitebooleanOptional

The invite status of the service provider

Example: true
fileIdintegerOptional

The file ID associated with the service provider

Example: 1
zipCodestringOptional

The zip code of the service provider

Example: 12345Pattern: ^\d{5}(-\d{4})?$
statestringOptional

The state of the service provider

Example: CAPattern: ^[A-Z]{2}$
externalIdstringOptional

The external ID of the service provider

Example: ext123Pattern: ^[a-zA-Z0-9_-]+$
organizationAddressesArray[]Optional

The organization addresses of the service provider

Default: []Example: [{}]
authenticationIdstringOptional

The authentication ID of the service provider

Example: auth123Pattern: ^[a-zA-Z0-9\-_]+$
partnerIdnumberOptional

The partner ID of the service provider

Example: 1
serviceableRadiusnumberOptional

The serviceable radius of the service provider

Example: 10
populationTagsnumber[]Optional

The population tags associated with the service provider

Default: []Example: [1,2,3]
populationTagsToRemovenumber[]Optional

The population tags associated with the service provider

Default: []Example: [1,2,3]
Responses
chevron-right
200Success
application/json
put
/api/service-providers/{serviceProviderId}
200Success
PreviousOrganizationNext/

Was this helpful?