View insurance plans
GET {{baseUrl}}/insurance_plans?subdomain={{subdomain}}&page=1&per_page=5&include[]=<string>&include[]=<string>&payer_id=<string>&group_num=<string>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 300 per page | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response | |
payer_id | string | A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically | |
group_num | string | Group number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","payer_id":"\u003cstring\u003e","name":"\u003cstring\u003e","address":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","group_num":"\u003cstring\u003e","employer_name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","patient_coverages":[{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e"}]},{"id":"\u003cinteger\u003e","payer_id":"\u003cstring\u003e","name":"\u003cstring\u003e","address":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","group_num":"\u003cstring\u003e","employer_name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","patient_coverages":[{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e"}]}],"count":"\u003cinteger\u003e"}