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

Search completed successfully

application/json

401

Unauthorized - Invalid or missing OAuth token

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": "searchmedicare-test",
      "external_id": "TEST-1738780800000-abc123",
      "first_name": "SearchMedicare",
      "last_name": "Test",
      "medicare_number": "1EG4TE5MK73"
    },
    "redirect_url": "https://medicare.healthsherpa.com/agents/agent-name/plans/c7716192-7625-4351-a689-3df3b65ba0e2"
  }
}