JOjoincandidhealth
v1

Get Multi

Changed on
get/api/non-insurance-payers/v1

Request

Query parameters

namestring
categorystring

Fuzzy-match category names of non-insurance payers.

categories_exactstring

Filter by one or more categories by name. When multiple are present, non-insurance payers with any of the specified categories will be matched.

clinical_trial_idsstring uuid

Filter by one or more clinical trials by their clinical_trial_id. When multiple are present, non-insurance payers with any of the specified clinical trials will be matched.

enabledboolean
sort'NAME' | 'CATEGORY' | 'ENABLED' | 'UPDATED_AT'
sort_direction'asc' | 'desc'
limitinteger

Defaults to 100

page_tokenstring
organization_idstring uuid

Filter to a specific organization's non-insurance payers. If not provided, defaults to the requesting user's organization.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • 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 new enum value CATEGORY to the query request parameter sort

    • info

      added the new enum value ENABLED to the query request parameter sort

    • info

      added the new enum value NAME to the query request parameter sort

    • info

      added the new enum value UPDATED_AT to the query request parameter sort

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • 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 get_multi removed and replaced with v1_get_multi_8