JOjoincandidhealth
v1

Get non-insurance payer categories

Changed on

Returns a paginated list of all non-insurance payer categories.

Non-insurance payer categories are simply strings and are not stored as a separate object in Candid. They are created when added to at least one non-insurance payer's category field and are deleted when there are no longer any non-insurance payers that contain them.

get/api/non-insurance-payers/v1/categories

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/non-insurance-payers/v1/categories
  • Auth
    HTTP bearer

Query parameters

search_termstring

Filters categories by fuzzy matching on name.

limitinteger

Limits the maximum number of categories that will be returned. Defaults to 100.

page_tokenstring

The page token to continue paging through a previous request.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring
itemsstring[] required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id getCategories removed and replaced with v1_getCategories