Skip to main content
GET
/
admin
/
providers
/
list
List Providers
curl --request GET \
  --url https://api.decodahealth.com/admin/providers/list \
  --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,
    "firebaseUid": "<string>",
    "visibleLocationIds": [
      "<string>"
    ],
    "permissions": [
      "<string>"
    ]
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

include_decoda
boolean
default:true
location_id
string | null

Response

Successful Response

id
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.

firstName
string | null

The user's first name.

lastName
string | null

The user's last name.

phoneNumber
string | null

The user's phone number.

email
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.

meta
Meta · object

Any additional metadata about the user relevant to your system.

isArchived
boolean | null

Whether the user is archived.

primaryLocationId
string | null

Primary location id of the provider.

lastActive
string<date-time> | null

Last active date of the provider.

bio
string | null

Bio of the provider.

profileImage
string | null

Profile image of the provider.

hasGoogleCalendar
boolean
default:false

Whether the provider has a Google Calendar.

nationalProviderIdentifier
string | null

National provider identifier of the provider.

bookingCapacity
integer | null

Booking capacity of the provider.

showIds
boolean
default:false

Whether to show IDs in the UI for this provider.

showWeekendsOnCalendar
boolean
default:true

Whether to show weekends on the calendar for this provider.

showCancelledAppointments
boolean
default:false

Whether to show cancelled appointments in the calendar for this provider.

showMessagesBox
boolean
default:true

Whether to show the messages box in the UI for this provider.

startCalendarHour
integer | null

The start hour of the calendar for this provider.

endCalendarHour
integer | null

The end hour of the calendar for this provider.

sendGcalInvites
boolean
default:false

Whether to send Google Calendar invites.

calendarGridInterval
integer | null

Grid interval in minutes for calendar display.

appointmentTimeStepMinutes
integer | null

Time step interval in minutes for appointment scheduling. If null, uses the smallest service duration.

showTranslucentPastEvents
boolean
default:true

Whether to show translucent past events in the calendar for this provider.

showGhostEvent
boolean
default:false

Whether to show ghost events on hover in the calendar for this provider.

autoSignOffNotes
boolean
default:true

Whether notes should automatically sign off when created.

firebaseUid
string | null

Firebase unique identifier for the provider.

visibleLocationIds
string[]

List of location IDs that the provider can see.

permissions
string[]

List of permissions associated with the provider.