Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Member Portal Invitations

Get an employee member portal invitation

Returns the current status of an employee's member portal invitation (pending, sent, verified, complete, or cancelled) along with an expired flag indicating whether the invitation can still be acted on by the employee.

scope: member_portal_invitation:read

get/v1/employees/{employee_id}/member_portal_invitations

Path parameters

employee_idstring required

The UUID of the employee

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Success

status'pending' | 'sent' | 'verified' | 'complete' | 'cancelled' required

Current status of the member portal invitation.

  • pending: The invitation record has been created but the invitation email has not yet been delivered.
  • sent: The invitation email has been delivered to the member.
  • verified: The member has been verified by the member portal partner.
  • complete: The member has fully completed their member portal registration.
  • cancelled: The invitation has been cancelled, either via DELETE on this endpoint or because it was superseded.
expiredboolean required

Whether the invitation can no longer be acted on by the member. Returns true when the invitation token has expired or when the invitation has been cancelled. To reissue an expired invitation, call POST on this endpoint again — a new token will be generated and will override the prior one.

Example response

{
  "status": "sent"
}