Skip to main content
GET
/
v1
/
organisations
/
{organisationId}
/
providers
List providers
curl --request GET \
  --url https://api.halth.com/v1/organisations/{organisationId}/providers
{
  "items": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "locationIds": [
        "<string>"
      ],
      "deleted": true,
      "mobileNumber": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "title": "Dr",
      "profileImageUrl": "<string>",
      "locationLinks": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "providerId": "<string>",
          "locationId": "<string>",
          "deleted": true,
          "acceptedTerms": true,
          "registrationStatus": "not_started",
          "applicationStatus": "not_started",
          "serviceTypeCode": "<string>",
          "categoryCode": "<string>",
          "medicare": {
            "suggestedProviderNumber": "<string>",
            "providerNumber": "<string>",
            "startDate": "2023-11-07T05:31:56Z",
            "registrationLetter": "<string>"
          },
          "association": {
            "registrationLetter": "<string>"
          }
        }
      ],
      "locations": [
        {
          "id": "<string>",
          "name": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "timeZone": "<string>",
          "address": {
            "line1": "<string>",
            "line2": "<string>",
            "suburb": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postcode": "<string>",
            "country": "<string>",
            "countryCode": "<string>"
          },
          "suggestedTaxIdentifier": "<string>",
          "bookingCustomText": "<string>",
          "businessId": "<string>",
          "business": {
            "id": "<string>",
            "name": "<string>",
            "settings": {
              "autoReconciliationEnabled": true
            },
            "taxIdentifier": "<string>",
            "countryCode": "<string>",
            "structure": "public_corporation",
            "merchantId": "<string>",
            "capabilities": [
              {
                "id": "bookings_client_management",
                "status": "inactive"
              }
            ]
          }
        }
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Path Parameters

organisationId
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

expand
enum<string>[]
Available options:
locationLinks,
locations
locationIds
string[]
Required array length: 1 - 100 elements
providerIds
string[]
Required array length: 1 - 100 elements

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10