REST APIPOST

Zaproszenia

Zaproś kogoś do organizacji i jej obszarów roboczych, wyświetl zaproszenia obszaru roboczego i unieważnij oczekujące.

POSThttps://post.adaptlypost.com/post/api/v1/invitations

Wysyła e-mailem zaproszenie ważne 7 dni. Po jego przyjęciu osoba dołącza do organizacji z rolą organizationRole i do każdego wymienionego obszaru roboczego z przypisaną mu rolą.

Klucz API (token Bearer)
Uprawnienie:members.manageRole i uprawnienia

Treść żądania

ParametrTypOpis
emailWYMAGANEstringAdres e-mail, na który wysłać zaproszenie.
organizationRolestringorg-member (domyślnie) lub org-admin. Tylko właściciel organizacji może zaprosić org-admin.
workspacesWYMAGANEobject[]Co najmniej jedna pozycja, każda z workspaceId i role (admin, editor, contributor lub viewer).
creditAllowanceobjectKredyty AI, które członek może wydać z planu. { mode: MONTHLY, monthlyAmount } odnawia się do wartości od 1 do 100000 kredytów w każdym cyklu planu. { mode: FIXED, balance } zaczyna się od 0 do 100000 kredytów i zmienia się tylko przy wydawaniu lub zmianie. Może go ustawić tylko właściciel lub administrator organizacji.

Gdy twórca klucza nie jest właścicielem ani administratorem organizacji, może zapraszać tylko jako org-member, tylko do obszarów roboczych, w których ma members.manage, i tylko z rolą nie wyższą niż jego własna w danym obszarze.

Zwraca 201 z zaproszeniem. Adres, który ma już oczekujące zaproszenie lub jest już członkiem, zwraca 400. Plan bez wolnego miejsca w zespole zwraca 403 subscription_required.

Wskazówka dla agentów: przed wysłaniem należy pokazać użytkownikowi adres e-mail, rolę w organizacji i każdy obszar roboczy z jego rolą oraz uzyskać zgodę. E-mail zostaje wysłany od razu.

Pola zaproszenia

PoleOpis
idID zaproszenia. Służy do unieważnienia zaproszenia.
emailZaproszony adres e-mail.
organizationIdOrganizacja, do której dołącza osoba.
organizationRoleRola w organizacji nadawana po przyjęciu zaproszenia.
statuspending, accepted, expired lub revoked.
workspacesKażdy obszar roboczy, do którego osoba dołącza, z workspaceId, workspaceName (lub null) i role.
expiresAtKiedy zaproszenie przestaje działać, 7 dni po wysłaniu.
createdAtKiedy wysłano zaproszenie.

Lista zaproszeń

GEThttps://post.adaptlypost.com/post/api/v1/invitations

Zwraca zaproszenia obejmujące obszar roboczy, w którym działa wywołanie, od najnowszych.

Klucz API (token Bearer)
Uprawnienie:members.manageRole i uprawnienia

Parametry zapytania

ParametrTypOpis
limitnumberOd 1 do 100 zaproszeń na stronę. Domyślnie 20.
offsetnumberIle zaproszeń pominąć. Domyślnie 0.

Odpowiedź zawiera invitations, total i hasMore. Dopóki hasMore ma wartość true, należy dodać limit do offset i wywołać ponownie.

Odpowiedź 200
{
  "invitations": [
    {
      "id": "inv_07r2t",
      "email": "sam@example.com",
      "organizationId": "org_01hzq",
      "organizationRole": "org-member",
      "status": "pending",
      "workspaces": [{ "workspaceId": "ag_01j9x", "workspaceName": "Acme", "role": "editor" }],
      "expiresAt": "2026-11-25T10:00:00.000Z",
      "createdAt": "2026-11-18T10:00:00.000Z"
    }
  ],
  "total": 1,
  "hasMore": false
}

Unieważnij zaproszenie

DELETEhttps://post.adaptlypost.com/post/api/v1/invitations/:id

Unieważnia oczekujące zaproszenie obejmujące obszar roboczy, w którym działa wywołanie, i zwraca 200 z zaproszeniem, już unieważnionym.

Klucz API (token Bearer)
Uprawnienie:members.manageRole i uprawnienia

Tylko właściciel organizacji może unieważnić zaproszenie dla administratora organizacji. Zaproszenie, które nie jest już oczekujące, zwraca 400. Id bez zaproszenia dla tego obszaru roboczego zwraca 404.

Odmowy

403 z kodem permission_denied oznacza, że rola klucza nie ma tego uprawnienia albo twórca klucza nie jest właścicielem ani administratorem organizacji tam, gdzie wywołanie tego wymaga. Odpowiedź jest ostateczna, więc nie należy ponawiać. Należy poprosić użytkownika, by zmianę wprowadził administrator organizacji.

403 z kodem subscription_required oznacza, że plan nie jest aktywny lub osiągnął limit: brak miejsca na kolejny obszar roboczy albo brak wolnego miejsca w zespole na zaproszenie. Treść zawiera też errorCode, limitKey, limit i currentUsage. Należy poprosić użytkownika o podniesienie planu i nie ponawiać.

403 Forbidden: osiągnięto limit planu
{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "subscription_required",
  "errorCode": "LIMIT_EXCEEDED",
  "limitKey": "max_workspaces",
  "limit": 3,
  "currentUsage": 3,
  "message": "..."
}

Kod 429 oznacza przekroczenie limitu żądań. Przed kolejnym wywołaniem należy odczekać czas podany w Retry-After.

Zaproszenie osoby
curl --request POST \
  --url https://post.adaptlypost.com/post/api/v1/invitations \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "sam@example.com",
    "organizationRole": "org-member",
    "workspaces": [{ "workspaceId": "ag_01j9x", "role": "editor" }],
    "creditAllowance": { "mode": "MONTHLY", "monthlyAmount": 200 }
  }'
Lista zaproszeń
curl --request GET \
  --url 'https://post.adaptlypost.com/post/api/v1/invitations?limit=20&offset=0' \
  --header 'Authorization: Bearer <api-key>'
Unieważnienie zaproszenia
curl --request DELETE \
  --url https://post.adaptlypost.com/post/api/v1/invitations/inv_07r2t \
  --header 'Authorization: Bearer <api-key>'
201
{
  "id": "inv_07r2t",
  "email": "sam@example.com",
  "organizationId": "org_01hzq",
  "organizationRole": "org-member",
  "status": "pending",
  "workspaces": [
    { "workspaceId": "ag_01j9x", "workspaceName": "Acme", "role": "editor" }
  ],
  "expiresAt": "2026-11-25T10:00:00.000Z",
  "createdAt": "2026-11-18T10:00:00.000Z"
}