Creating a Service Provider

Service providers in our platform are users who deliver various services to consumers, typically including doctors and organizational staff. Each organization can configure specific roles for their service providers, ensuring a customized setup that aligns with operational requirements and workflows.

Configuration

When creating a service provider, it is essential to include a valid externalId if the provider will interact with external systems. For example, if an appointment is booked under a service provider's name and the organization’s EMR integration involves an external system, the externalId acts as the reference needed for seamless communication between platforms. Additionally, roles and sub-roles can be assigned during the creation process to ensure proper access and functionality within the organization.

Before adding new service providers, the authentication configuration must be completed by a config user. This setup ensures that service providers can be securely created and integrated into the system with appropriate permissions.

Implementation

Only administrators have the authority to add service providers with an externalId. This restriction ensures that external integrations, such as those with EMR systems, are managed securely and efficiently. Once the authentication configuration is in place, a new service provider can be added as shown below:

Add a new service provider

post

Create a new service provider

Body

application/json

idintegerOptional

firstNamestringRequired

lastNamestringOptional

emailstringRequired

mobilestringOptional

birthDateone ofOptional

string · dateOptional

or

string · date-timeOptional

genderstring · enumOptionalPossible values:

timeZonestringOptional

activebooleanRequired

attributesstringOptional

rolestring · enumOptionalPossible values:

rolesstring[]Optional

subRolesinteger[]Optional

onboardingStatusstringOptional

organizationobjectRequired

invitebooleanOptional

fileIdintegerOptional

profilePicobjectOptional

zipCodestringOptional

statestringOptional

externalIdstringOptional

addressesobject[]Optional

organizationAddressesobject[]Optional

authenticationIdstringOptional

Responses

200Success

application/json

post

/service-providers/

HTTPcURLJavaScriptPython

POST /service-providers/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 425

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "mobile": "text",
  "birthDate": "2026-02-07",
  "gender": "MALE",
  "timeZone": "text",
  "active": true,
  "attributes": "text",
  "role": "OWNER",
  "roles": [
    "text"
  ],
  "subRoles": [
    1
  ],
  "onboardingStatus": "text",
  "organization": {},
  "invite": true,
  "fileId": 1,
  "profilePic": {},
  "zipCode": "text",
  "state": "text",
  "externalId": "text",
  "addresses": [
    {}
  ],
  "organizationAddresses": [
    {}
  ],
  "authenticationId": "text"
}

200Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "mobile": "text",
  "birthDate": "2026-02-07",
  "gender": "MALE",
  "timeZone": "text",
  "active": true,
  "attributes": "text",
  "role": "OWNER",
  "roles": [
    "text"
  ],
  "subRoles": [
    1
  ],
  "onboardingStatus": "text",
  "organization": {},
  "invite": true,
  "fileId": 1,
  "profilePic": {},
  "zipCode": "text",
  "state": "text",
  "externalId": "text",
  "addresses": [
    {}
  ],
  "organizationAddresses": [
    {}
  ],
  "authenticationId": "text"
}

Once the service provider is created you can also add additional roles to them to drive relevant operation workflows

Add or update service provider role

post

Add or update roles for a service provider

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

Bodyobject[]

application/json

object[]Optional

Responses

200Success

application/json

post

/service-providers/{serviceProviderId}/role

HTTPcURLJavaScriptPython

POST /service-providers/{serviceProviderId}/role HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

200Success

[
  {
    "serviceProviderId": 1,
    "role": "OWNER",
    "subRoles": [
      1
    ],
    "active": true
  }
]

SubRoles can also be set for a more granular role configuration, the platform allows for creation and management for dynamic subroles

Create a new sub role

post

Create a new service provider sub role

Body

application/json

namestringRequired

descriptionstringOptional

organizationIdnumberRequired

rolestring · enumRequiredPossible values:

Responses

200Success

application/json

post

/service-provider-sub-roles/

HTTPcURLJavaScriptPython

POST /service-provider-sub-roles/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "text",
  "description": "text",
  "organizationId": 1,
  "role": "OWNER"
}

200Success

{
  "id": 1,
  "name": "text",
  "description": "text",
  "organizationId": 1,
  "organization": {},
  "createdAt": "2026-02-07",
  "updatedAt": "2026-02-07",
  "role": "OWNER"
}