Skip to main content
GET
/
v1
/
plans
List plans
curl --request GET \
  --url https://demo1-api.payrollintegrationsdemo.com/v1/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "displayName": "Example 401(k) Plan",
      "tpes": [
        {
          "tpeId": "660e8400-e29b-41d4-a716-446655440001",
          "planIdentifier": "PLAN-12345"
        }
      ],
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z"
    }
  ],
  "meta": {
    "limit": 10,
    "offset": 0,
    "sort": "createdAt",
    "currentCount": 1,
    "totalCount": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

List of plans

data
object[]
required
meta
object
required