Search Contact

Search for a contact

post

https://api.medicare.healthsherpa.com/v2https://api.medicare-staging.healthsherpa.com/v2

/contacts/search

Searches for a contact in the HealthSherpa system created by the authenticated agent. You can search by medicare number alone, OR by using a combination of name (first name or last name) with at least one of: date of birth, email, or phone.

Required scopes

This endpoint requires the following scopes:

• : Access to Partner API v2 endpoints

Authorizations

OAuth2

OAuth2authorizationCodeRequired

OAuth 2.0 authentication with partner_api_v2 scope

Authorization URL: Token URL:

Body

application/json

Responses

200

Contact found successfully

application/json

401

Unauthorized - Invalid or missing OAuth token

application/json

404

Contact or agent not found

application/json

422

Invalid search parameters

application/json

post

/contacts/search

HTTPcURLJavaScriptPython

POST /v2/contacts/search HTTP/1.1
Host: api.medicare.healthsherpa.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "params": {
    "medicare_number": "1EG4TE5MK73",
    "first_name": "Alex",
    "last_name": "Lee",
    "birth_date": "01/15/1955",
    "email": "[email protected]",
    "phone": "8557722663"
  }
}

{
  "data": {
    "contact": {
      "id": "c7716192-7625-4351-a689-3df3b65ba0e2",
      "slug": "some-slug",
      "external_id": "CRM123456",
      "first_name": "Alex",
      "last_name": "Lee",
      "address_1": "1215 19th St",
      "address_2": "Suite 100",
      "birth_date": "01/15/1955",
      "city": "Sacramento",
      "state": "CA",
      "zip": "95811",
      "phone": "8557722663",
      "sex": "male",
      "email": "[email protected]",
      "medicare_number": "1EG4TE5MK73",
      "medicare_part_a_effective_date": "01/01/2024",
      "medicare_part_b_effective_date": "01/01/2024",
      "medicaid_eligible": false,
      "medicaid_number": "MED123456",
      "extra_help": false,
      "type": "client",
      "notes": [
        "Initial contact made on 03/20/2024"
      ],
      "authorized_representative_name": "Jane Doe",
      "authorized_representative_relationship": "spouse",
      "authorized_representative_phone_number": "8551234567",
      "authorized_representative_email": "[email protected]",
      "authorized_representative_address": "456 Oak Ave",
      "authorized_representative_city": "Sacramento",
      "authorized_representative_state": "CA",
      "authorized_representative_zip_code": "95811",
      "mailing_address_street": "789 Mailing Ln",
      "mailing_address_unit_number": "Apt 2B",
      "mailing_address_city": "Sacramento",
      "mailing_address_state": "CA",
      "mailing_address_zip_code": "95811",
      "contact_drugs_attributes": [
        {
          "name": "amoxicillin",
          "drug_type_id": 1,
          "dosage_name": "amoxicillin CAP 250MG",
          "ndc": "54570126563",
          "frequency": 30,
          "user_quantity": 100,
          "id": "drug-1",
          "id_source": "connecture",
          "dosage_id": "dosage-1",
          "dosage_id_source": "connecture",
          "package_id": "package-1",
          "package_id_source": "connecture",
          "package_description": "Bottle",
          "package_size": 10,
          "package_quantity": 1,
          "metric_quantity": 5
        }
      ],
      "contact_pharmacies_attributes": [
        {
          "id": "pharm-1",
          "id_source": "connecture",
          "name": "Neighborhood Pharmacy",
          "mode": "retail",
          "npi": "3878698333",
          "primary": true,
          "phone_number": "[phone]",
          "address_street": "123 Medical Blvd",
          "address_unit_number": "Suite 100",
          "address_city": "Durham",
          "address_state": "NC",
          "address_zip_code": "27707"
        }
      ],
      "contact_providers_attributes": [
        {
          "external_id": "provider-1",
          "provider_type": "individual",
          "id": "prov-123",
          "id_source": "connecture",
          "primary": true,
          "first_name": "Chelsey",
          "last_name": "Schneider",
          "organization_name": "Health Group",
          "presentation_name": "Dr. Chelsey Schneider, MD",
          "phone_number": "[phone]",
          "npi": "1234567890",
          "specialties": [
            "Internal Medicine",
            "Cardiology"
          ],
          "contact_provider_addresses_attributes": [
            {
              "id": "addr-123",
              "id_source": "connecture",
              "street": "123 Medical Blvd",
              "unit_number": "Suite 100",
              "city": "Durham",
              "state": "NC",
              "zip_code": "27707",
              "phone_numbers": [
                "919-555-0123",
                "919-555-0124"
              ],
              "selected": true
            }
          ]
        }
      ]
    },
    "redirect_url": "https://medicare.healthsherpa.com/agents/agent-name/plans/contact-id?search=%7B%3Azip%3D%3E%2298134%22%7D"
  }
}