/

Get service providers

get

Retrieve service providers by query filter

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

emailstringOptional

Email address of the service provider

Example: [email protected]

phonestringOptional

Phone number of the service provider

Example: [phone]

isGroupbooleanOptional

Indicates if the service provider is a group

activebooleanOptional

isPartnerbooleanOptional

Indicates if the service provider is a partner

externalIdstringOptional

firstNamestringOptional

First name of service provider

Example: John

lastNamestringOptional

Last name of service provider

Example: Doe

isExternalbooleanOptional

Indicates if the service provider is external

attributesobjectOptional

Responses

200Success

application/json

get

/api/service-providers/

HTTPcURLJavaScriptPython

GET /api/service-providers/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "mobile": "[phone]",
    "birthDate": "1990-01-01",
    "gender": "MALE",
    "timeZone": "UTC",
    "active": true,
    "isExternal": true,
    "attributes": "{}",
    "role": "CLIENT_MANAGER",
    "roles": [
      "role1",
      "role2"
    ],
    "subRoles": [
      1,
      2
    ],
    "onboardingStatus": "completed",
    "organization": {
      "id": 1
    },
    "invite": true,
    "fileId": 1,
    "profilePic": {
      "id": 123,
      "name": "example.txt",
      "cloudId": "121/0081905e-c201-4277-8fda-8ad296573f581737719364614",
      "resource": {},
      "mimeType": "application/pdf",
      "personId": 123,
      "documentLabelId": 123,
      "externalId": "ext123",
      "attributes": {},
      "archived": true,
      "labels": {},
      "relatedFiles": {},
      "updatedBy": {}
    },
    "zipCode": "12345",
    "state": "CA",
    "externalId": "ext123",
    "addresses": [
      {}
    ],
    "organizationAddresses": [
      {}
    ],
    "authenticationId": "auth123",
    "populationTags": [
      1,
      2
    ],
    "partnerId": 1,
    "serviceableRadius": 10
  }
]

Add a new service provider

post

Create a new service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

idintegerOptional

The unique identifier of the service provider

Example: 1

firstNamestringRequired

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 · emailRequired

The email address of the service provider

Example: [email protected]

mobilestringOptional

The mobile number of the service provider

Example: [phone]

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_/+-]+$

activebooleanRequired

The active status of the service provider

Example: true

isExternalbooleanOptional

Indicates if the service provider is external

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_-]+$

organizationAddressesany[]Optional

The organization addresses of the service provider

Default: []Example: [{}]

authenticationIdstringOptional

The authentication ID of the service provider

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

populationTagsnumber[]Optional

The tags of the service provider

Default: []Example: [1,2]

partnerIdnumberOptional

The partner ID of the service provider

Example: 1

serviceableRadiusnumberOptional

The serviceable radius of the service provider

Example: 10

Responses

200Success

application/json

post

/api/service-providers/

HTTPcURLJavaScriptPython

POST /api/service-providers/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 831

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "mobile": "[phone]",
  "birthDate": "1990-01-01",
  "gender": "MALE",
  "timeZone": "UTC",
  "active": true,
  "isExternal": true,
  "attributes": "{}",
  "role": "CLIENT_MANAGER",
  "roles": [
    "role1",
    "role2"
  ],
  "subRoles": [
    1,
    2
  ],
  "onboardingStatus": "completed",
  "organization": {
    "id": 1
  },
  "invite": true,
  "fileId": 1,
  "profilePic": {
    "id": 123,
    "name": "example.txt",
    "cloudId": "121/0081905e-c201-4277-8fda-8ad296573f581737719364614",
    "resource": {},
    "mimeType": "application/pdf",
    "personId": 123,
    "documentLabelId": 123,
    "externalId": "ext123",
    "attributes": {},
    "archived": true,
    "labels": {},
    "relatedFiles": {},
    "updatedBy": {}
  },
  "zipCode": "12345",
  "state": "CA",
  "externalId": "ext123",
  "addresses": [
    {}
  ],
  "organizationAddresses": [
    {}
  ],
  "authenticationId": "auth123",
  "populationTags": [
    1,
    2
  ],
  "partnerId": 1,
  "serviceableRadius": 10
}

200Success

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "mobile": "[phone]",
  "birthDate": "1990-01-01",
  "gender": "MALE",
  "timeZone": "UTC",
  "active": true,
  "isExternal": true,
  "attributes": "{}",
  "role": "CLIENT_MANAGER",
  "roles": [
    "role1",
    "role2"
  ],
  "subRoles": [
    1,
    2
  ],
  "onboardingStatus": "completed",
  "organization": {
    "id": 1
  },
  "invite": true,
  "fileId": 1,
  "profilePic": {
    "id": 123,
    "name": "example.txt",
    "cloudId": "121/0081905e-c201-4277-8fda-8ad296573f581737719364614",
    "resource": {},
    "mimeType": "application/pdf",
    "personId": 123,
    "documentLabelId": 123,
    "externalId": "ext123",
    "attributes": {},
    "archived": true,
    "labels": {},
    "relatedFiles": {},
    "updatedBy": {}
  },
  "zipCode": "12345",
  "state": "CA",
  "externalId": "ext123",
  "addresses": [
    {}
  ],
  "organizationAddresses": [
    {}
  ],
  "authenticationId": "auth123",
  "populationTags": [
    1,
    2
  ],
  "partnerId": 1,
  "serviceableRadius": 10
}