Get Provider

curl --request GET \
  --url https://api.decodahealth.com/admin/providers/{provider_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "type": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "userType": "ADMIN",
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "locationId": "<string>",
  "externalId": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "isArchived": true,
  "primaryLocationId": "<string>",
  "lastActive": "2023-11-07T05:31:56Z",
  "bio": "<string>",
  "profileImage": "<string>",
  "hasGoogleCalendar": false,
  "nationalProviderIdentifier": "<string>",
  "bookingCapacity": 123,
  "showIds": false,
  "showWeekendsOnCalendar": true,
  "showCancelledAppointments": false,
  "showMessagesBox": true,
  "startCalendarHour": 123,
  "endCalendarHour": 123,
  "sendGcalInvites": false,
  "calendarGridInterval": 123,
  "appointmentTimeStepMinutes": 123,
  "showTranslucentPastEvents": true,
  "showGhostEvent": false,
  "autoSignOffNotes": true
}

GET

admin

providers

{provider_id}

Get Provider

curl --request GET \
  --url https://api.decodahealth.com/admin/providers/{provider_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "type": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "userType": "ADMIN",
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "locationId": "<string>",
  "externalId": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "isArchived": true,
  "primaryLocationId": "<string>",
  "lastActive": "2023-11-07T05:31:56Z",
  "bio": "<string>",
  "profileImage": "<string>",
  "hasGoogleCalendar": false,
  "nationalProviderIdentifier": "<string>",
  "bookingCapacity": 123,
  "showIds": false,
  "showWeekendsOnCalendar": true,
  "showCancelledAppointments": false,
  "showMessagesBox": true,
  "startCalendarHour": 123,
  "endCalendarHour": 123,
  "sendGcalInvites": false,
  "calendarGridInterval": 123,
  "appointmentTimeStepMinutes": 123,
  "showTranslucentPastEvents": true,
  "showGhostEvent": false,
  "autoSignOffNotes": true
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

provider_id

string

required

Response

Successful Response

string

required

The unique identifier for the user.

type

string

required

Type of the user, fixed as 'provider'.

createdDate

string<date-time>

required

The date and time when the user was created.

roles

RoleSummary · object[]

required

List of roles associated with the provider.

Show child attributes

roles.id

string

required

Unique identifier for the role

roles.name

string

required

Role name (e.g., 'admin', 'user', 'billing_manager')

roles.userType

enum<string>

required

Role type (ADMIN, PROVIDER, USER)

Available options:

ADMIN,

PROVIDER,

USER

roles.createdDate

string<date-time> | null

When the role was created

roles.updatedDate

string<date-time> | null

When the role was last updated

firstName

string | null

The user's first name.

lastName

string | null

The user's last name.

phoneNumber

string | null

The user's phone number.

string | null

The user's email address.

locationId

string | null

The location of the user.

externalId

string | null

The user's external identifier if available.

address

string | null

The user's primary address.

addressLineTwo

string | null

Additional address information.

city

string | null

The city of the user's address.

state

string | null

The state of the user's address.

zipCode

string | null

The postal code of the user's address.

country

string | null

The country of the user's address.

addressValid

boolean | null

Whether the user's address is valid.

Getting Started

API

Tenant

Webhook

Get Provider

Headers

Path Parameters

Response