Skip to main content
GET
/
v1
/
plans
/
{plan}
/
invites
List plan invites
curl --request GET \
  --url https://demo1-api.payrollintegrationsdemo.com/v1/plans/{plan}/invites \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "planId": "550e8400-e29b-41d4-a716-446655440000",
      "email": "[email protected]",
      "status": "pending",
      "createdAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-22T10:30: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.

Path Parameters

plan
string<uuid>
required

Response

List of plan invites

data
object[]
required
meta
object
required