Invitation

Invite users and handle onboarding flows.

Get organizations invitations

get

/organizations/{organizationId}/invitations

Get organizations invitations by organization user

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

Current page number

Default: 1

sortstringOptional

Sort

Example: {"value":"createdAt"}

statusstringOptional

Status

Responses

200

OK

application/json

totalDocsintegerRequired

The total number of users

limitintegerRequired

The limit of users per page

Default: 10

pageintegerRequired

Current page

Default: 1

totalPagesintegerRequired

The total number of pages

pagingCounterintegerRequired

Current page number

hasPrevPagebooleanRequired

Has previous page

hasNextPagebooleanRequired

Has next page

prevPageintegerRequired

Previous page number

nextPageintegerRequired

Next page number

401

Unauthorized

application/json

403

Forbidden

application/json

get/organizations/{organizationId}/invitations

GET /api/v1/organizations/{organizationId}/invitations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 1,
  "limit": 10,
  "page": 1,
  "totalPages": 1,
  "pagingCounter": 1,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 1,
  "docs": [
    {
      "email": "text",
      "token": "text",
      "organization": {
        "_id": "text",
        "name": "text",
        "slug": "text",
        "description": "text",
        "owner": "text",
        "isExecutive": false,
        "status": 0,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "text",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "user": "63ea10b94a472e003305232b",
      "registered": {
        "completedAt": "2026-01-01T00:00:00.000Z",
        "user": "63ea10b94a472e003305232b"
      },
      "status": "pending",
      "validatedAt": "2026-01-01T00:00:00.000Z",
      "_id": "63ea10b94a472e003305232b",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a organization invitation

post

/organizations/{organizationId}/invitations

Create a organization invitation by organization user

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

emailstring · min: 3 · max: 255Required

Invitation email

Example: [e-mail]

rolesstring[]Optional

Entity ID

validatedAtstring · date-timeRequired

Date

Responses

201

Created

application/json

emailstringRequired

Invitation email

tokenstringRequired

Invitation token

userstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

statusstring · enumOptional

Invitation status

Default: pendingPossible values:

validatedAtstring · date-timeRead-onlyOptional

Date

_idstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

createdAtstring · date-timeRead-onlyOptional

Date

updatedAtstring · date-timeRead-onlyOptional

Date

400

Bad Request

application/json

401

Unauthorized

application/json

post/organizations/{organizationId}/invitations

POST /api/v1/organizations/{organizationId}/invitations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "email": "[e-mail]",
  "roles": [
    "text"
  ],
  "validatedAt": "2026-01-01T00:00:00.000Z"
}

{
  "email": "text",
  "token": "text",
  "organization": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "owner": "text",
    "isExecutive": false,
    "status": 0,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "user": "63ea10b94a472e003305232b",
  "registered": {
    "completedAt": "2026-01-01T00:00:00.000Z",
    "user": "63ea10b94a472e003305232b"
  },
  "status": "pending",
  "validatedAt": "2026-01-01T00:00:00.000Z",
  "_id": "63ea10b94a472e003305232b",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get a invitation

get

/public/invitations/{token}/check

Get a invitation code status

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

Invitation token

Responses

200

OK

application/json

string · enumOptionalPossible values:

get/public/invitations/{token}/check

GET /api/v1/public/invitations/{token}/check HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

registered