HR Software Find a Benefit Plan API Support

Find a Benefit Plan
Home > Resources > Find a Benefit Plan

This API retrieves benefits enrollment data as of the current date for a specific benefit plan. The result will return all enrolled members for the benefit plan specified in the resource URL. This API can be used in conjuction with the Employee Benefits API.

Resource URL

https://serverurl/path/v1.1/benefits/

[plan id] is the unique plan identifier.

Example Request
GET	https://serverurl/api/v1.1/benefits/

Return Value

XML

All Plans

<groupNumber />
    <cobraAvailable>false</cobraAvailable>
    <startDate>1995-01-01T00:00:00</startDate>
    <stopDate xsi:nil="true" />
  <benefit>
    <planId>24</planId>
    <planName>Snap Distributing Dental</planName>
    <carrierId>16</carrierId>
    <groupNumber />
    <cobraAvailable>true</cobraAvailable>
    <startDate>1991-01-01T00:00:00</startDate>
    <stopDate xsi:nil="true" />
  </benefit>

Single Plan

<benefit>
  <planId>22</planId>
  <planName>401K Plan</planName>
  <carrierId>15</carrierId>
  <groupNumber />
  <cobraAvailable>false</cobraAvailable>
  <startDate>1995-01-01T00:00:00</startDate>
  <stopDate xsi:nil="true" />
</benefit>

JSON

All Plans

{"benefits":
  [{"planId":22,
"planName":"401K  Plan",
"carrierId":15,
"groupNumber":"",
"cobraAvailable":"false",
"startDate":"1995-01-01T00:00:00"},
{"planId":24,
"planName":"Snap Distributing Dental",
"carrierId":16,
"groupNumber":"",
"cobraAvailable":"true",
"startDate":"1991-01-01T00:00:00"}
]}

Single Plan

{"planId":22,
"planName":"401K  Plan",
"carrierId":15,
"groupNumber":"",
"cobraAvailable":"false",
"startDate":"1995-01-01T00:00:00"}

Resource Information
Requires Authentication?	Yes
Response Formats	json xml
HTTP Methods	GET
Request Content	N/A
Return Code	200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: Plan does not exist