Enrollments

The Enrollments API allows businesses to programmatically invite new users to their organization, assigning them roles and workspace access from the moment of onboarding. It also provides visibility into the status of pending and processed invitations, enabling automated and auditable user onboarding workflows.

List enrollments

get

Returns a paginated list of user enrollments (invitations) for the organization filtered by status. Requires can_manage_users permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Query parameters

pageintegerOptional

Page number (0-based)

Default: 0

sizeintegerOptional

Page size (default 20)

Default: 20

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

500

Internal Server Error – unexpected server error

application/json

get

/organizations/enrollments

GET /organizations/enrollments HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "content": [
    {
      "enrollmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "[email protected]",
      "status": "PENDING",
      "lastInvitationSentAt": "2025-01-01T10:00:00Z"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0
}

Invite a user to the organization

post

Send an invitation to a user to join the organization with a specified role and optional workspace assignments. Requires can_manage_users permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Body

emailstringRequired

Email address of the user to invite

roleIdstring · uuidRequired

Identifier of the organization role to assign

firstNamestring · nullableOptional

First name of the user

lastNamestring · nullableOptional

Last name of the user

titlestring · nullableOptional

Job title of the user

Responses

201

Created – invitation sent successfully

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

post

/organizations/enrollments

POST /organizations/enrollments HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "email": "[email protected]",
  "roleId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "firstName": "Jan",
  "lastName": "Kowalski",
  "title": "Developer",
  "workspaceAssignments": [
    {
      "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "roleId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  ]
}

{
  "enrollmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "[email protected]",
  "status": "PENDING",
  "lastInvitationSentAt": "2025-01-01T10:00:00Z"
}

Resend invitation

post

Resend an existing enrollment invitation. Requires can_manage_users permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

enrollmentIdstring · uuidRequired

Identifier of the enrollment

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

post

/organizations/enrollments/{enrollmentId}/resend

POST /organizations/enrollments/{enrollmentId}/resend HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "enrollmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "[email protected]",
  "status": "PENDING",
  "lastInvitationSentAt": "2025-01-02T10:00:00Z"
}

Cancel invitation

post

Cancel a pending enrollment invitation. Requires can_manage_users permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

enrollmentIdstring · uuidRequired

Identifier of the enrollment to cancel

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

204

204 No Content

No content

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

post

/organizations/enrollments/{enrollmentId}/cancel

POST /organizations/enrollments/{enrollmentId}/cancel HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

No content

PreviousUsers NextWorkspace memberships

Last updated 1 month ago