Get Multi | Candid | API Reference

curl https://api.joincandidhealth.com/api/non-insurance-payers/v1 \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "name": "name",
      "enabled": true,
      "clinical_trials": [
        {
          "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_number": "clinical_trial_number",
          "is_active": true,
          "name": "name",
          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_phase": "Phase 1"
        },
        {
          "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_number": "clinical_trial_number",
          "is_active": true,
          "name": "name",
          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_phase": "Phase 1"
        }
      ],
      "description": "description",
      "category": "category",
      "address": {
        "address1": "address1",
        "city": "city",
        "state": "AA",
        "zip_code": "zip_code",
        "address2": "address2",
        "zip_plus_four_code": "zip_plus_four_code"
      }
    },
    {
      "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "name": "name",
      "enabled": true,
      "clinical_trials": [
        {
          "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_number": "clinical_trial_number",
          "is_active": true,
          "name": "name",
          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_phase": "Phase 1"
        },
        {
          "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_number": "clinical_trial_number",
          "is_active": true,
          "name": "name",
          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "clinical_trial_phase": "Phase 1"
        }
      ],
      "description": "description",
      "category": "category",
      "address": {
        "address1": "address1",
        "city": "city",
        "state": "AA",
        "zip_code": "zip_code",
        "address2": "address2",
        "zip_plus_four_code": "zip_plus_four_code"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "prev_page_token": "prev_page_token"
}

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

namestringOptional

categorystringOptional

Fuzzy-match category names of non-insurance payers.

categories_exactstringOptional

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_idsUUIDOptional

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.

enabledbooleanOptional

sortenumOptional

Allowed values:

sort_directionenumOptional

Allowed values:

limitintegerOptional

Defaults to 100

page_tokenstringOptional

organization_idUUIDOptional

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

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstring

prev_page_tokenstring

Errors

403

Unauthorized Error

422

Unprocessable Entity Error