Skip to main content
GET
/
v1
/
plans
/
{plan}
Get plan by ID
curl --request GET \
  --url https://demo1-api.payrollintegrationsdemo.com/v1/plans/{plan} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

plan
string<uuid>
required

Unique identifier (UUID) of the plan

Response

Plan data with complete details

id
string<uuid>
required

Unique identifier for the plan

displayName
string
required

Display name of the plan

tpes
object[]
required

Array of TPEs (Third Party Entities) associated with the plan

createdAt
string<date-time>
required

ISO 8601 timestamp when the plan was created