Providers
Provider List
Get a list of all Providers
GET
/
v1
/
provider
/
list
Headers
TENANT
string
requiredThe tenant you are making this request on behalf of
API-KEY
string
requiredYour api key
Response
200 - application/json
address
string | null
The user's primary address.
addressLineTwo
string | null
Additional address information.
addressValid
boolean | null
Whether the user's address is valid.
city
string | null
The city of the user's address.
country
string | null
The country of the user's address.
createdDate
string
requiredThe date and time when the user was created.
email
string | null
The user's email address.
externalUserId
string | null
The user's external identifier if available.
firstName
string
requiredThe user's first name.
id
string
requiredThe unique identifier for the user.
lastName
string | null
The user's last name.
meta
object | null
Any additional metadata about the user relevant to your system.
phoneNumber
string | null
The user's phone number.
roles
object[]
requiredList of roles associated with the provider.
state
string | null
The state of the user's address.
type
string
requiredType of the user, fixed as 'provider'.
zipCode
string | null
The postal code of the user's address.