MemberV2

Create, manipulate, and retrieve members.

GET /plans/[:plan_id]/members-v2

Retrieve a paginated list of members

Fields

Field Description Required
entity_id The unique entity_id at member entity and plan level. NO
first_name The member first name. NO
middle_name_initial The member's middle name initial. NO
last_name Member's last name NO
member_id The health insurance member ID NO
zip_code The member's address zip code. NO
household The member's household NO
plan_id The member's plan code NO
address_1 The member's address. NO
address_2 The member address field 2. NO
phone_number The member's phone number. NO
benefit_amount The member's benefit amount. NO
dob The member's date of birth NO
state_code The member's state code. NO
city The member's city. NO
enroll_date Member's enrollment date. NO
line_of_business The member's line of business. NO
is_able_to_order Tells if the member is able to order or not. NO
last_order Last member's order if any. NO
order_eligibility Member's order eligibility information. NO

Request

Headers

Header Value
Accept
application/vnd.members.v2+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.members.v2+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

Response body
{
   "_links": {
       "self": {
           "href": "/members"
       },
       "first": {
           "href": "/members?page={page}"
       },
       "prev": {
           "href": "/members?page={page}"
       },
       "next": {
           "href": "/members?page={page}"
       },
       "last": {
           "href": "/members?page={page}"
       }
   }
   "_embedded": {
       "member": [
           {
               "_links": {
                   "self": {
                       "href": "/members[/:member_id]"
                   }
               }
              "entity_id": "The unique entity_id at member entity and plan level.",
              "first_name": "The member first name.",
              "middle_name_initial": "The member's middle name initial.",
              "last_name": "Member's last name",
              "member_id": "The health insurance member ID",
              "zip_code": "The member's address zip code.",
              "household": "The member's household",
              "plan_id": "The member's plan code",
              "address_1": "The member's address.",
              "address_2": "The member address field 2.",
              "phone_number": "The member's phone number.",
              "benefit_amount": "The member's benefit amount.",
              "dob": "The member's date of birth",
              "state_code": "The member's state code.",
              "city": "The member's city.",
              "enroll_date": "Member's enrollment date.",
              "line_of_business": "The member's line of business.",
              "is_able_to_order": "Tells if the member is able to order or not.",
              "last_order": "Last member's order if any.",
              "order_eligibility": "Member's order eligibility information."
           }
       ]
   }
}

GET /plans/[:plan_id]/members-v2[/:member_entity_id]

Retrieve a member

Fields

Field Description Required
entity_id The unique entity_id at member entity and plan level. NO
first_name The member first name. NO
middle_name_initial The member's middle name initial. NO
last_name Member's last name NO
member_id The health insurance member ID NO
zip_code The member's address zip code. NO
household The member's household NO
plan_id The member's plan code NO
address_1 The member's address. NO
address_2 The member address field 2. NO
phone_number The member's phone number. NO
benefit_amount The member's benefit amount. NO
dob The member's date of birth NO
state_code The member's state code. NO
city The member's city. NO
enroll_date Member's enrollment date. NO
line_of_business The member's line of business. NO
is_able_to_order Tells if the member is able to order or not. NO
last_order Last member's order if any. NO
order_eligibility Member's order eligibility information. NO

Request

Headers

Header Value
Accept
application/vnd.members.v2+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.members.v2+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/members[/:member_id]"
       }
   }
   "entity_id": "The unique entity_id at member entity and plan level.",
   "first_name": "The member first name.",
   "middle_name_initial": "The member's middle name initial.",
   "last_name": "Member's last name",
   "member_id": "The health insurance member ID",
   "zip_code": "The member's address zip code.",
   "household": "The member's household",
   "plan_id": "The member's plan code",
   "address_1": "The member's address.",
   "address_2": "The member address field 2.",
   "phone_number": "The member's phone number.",
   "benefit_amount": "The member's benefit amount.",
   "dob": "The member's date of birth",
   "state_code": "The member's state code.",
   "city": "The member's city.",
   "enroll_date": "Member's enrollment date.",
   "line_of_business": "The member's line of business.",
   "is_able_to_order": "Tells if the member is able to order or not.",
   "last_order": "Last member's order if any.",
   "order_eligibility": "Member's order eligibility information."
}