REST APIGET

Obszary robocze

Wyświetl obszary robocze, w których może działać klucz API lub logowanie OAuth, z rolą i możliwościami w każdym, i wybieraj jeden na żądanie nagłówkiem X-Workspace-Id.

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

Zwraca obszary robocze, w których może działać użyty klucz lub logowanie OAuth, wraz z rolą i możliwościami w każdym z nich. Może go wywołać każdy ważny klucz, niezależnie od roli.

Klucz API (token Bearer)
Uprawnienie:dowolny ważny kluczRole i uprawnienia

Kiedy wywoływać

Warto wywołać go przy starcie integracji, zanim cokolwiek odczyta lub zapisze. Połączenie OAuth, takie jak łącznik Claude lub ChatGPT, ma dostęp do każdego obszaru roboczego członka, także w różnych organizacjach. Klucz API ma dostęp tylko do własnego obszaru roboczego, więc lista zawiera jedną pozycję.

Wskazówka dla agentów: jeśli lista zawiera więcej niż jeden obszar roboczy, a użytkownik żadnego nie wskazał, należy zapytać, którego użyć. Następnie należy wysyłać jego id w X-Workspace-Id przy każdym wywołaniu i odczytać jego can przed zaproponowaniem planowania lub publikacji.

Pola odpowiedzi

PoleOpis
idID obszaru roboczego. Wysłane w nagłówku X-Workspace-Id powoduje działanie w tym obszarze.
nameNazwa obszaru roboczego.
organizationOrganizacja będąca właścicielem obszaru roboczego, z jej id i nazwą.
roleRola w tym obszarze roboczym: key to admin, editor, contributor lub viewer; name to etykieta w języku użytkownika. W przypadku klucza API jest to rola klucza.
permissionsWszystkie uprawnienia w tym obszarze roboczym. W przypadku klucza API są to jego uprawnienia po uwzględnieniu aktualnej roli twórcy.
isDefaultTrue dla obszaru roboczego, do którego trafia wywołanie bez nagłówka X-Workspace-Id.
currentTrue dla obszaru roboczego, do którego trafiło to wywołanie.
canTrzy wartości logiczne, draft, schedule i publish, określające, co rola pozwala robić z postami w tym obszarze roboczym.

Wybór obszaru roboczego przez X-Workspace-Id

Każdy endpoint przyjmuje opcjonalny nagłówek X-Workspace-Id. Po ustawieniu go na id z tej listy wywołanie działa w tym obszarze roboczym, z przypisaną tam rolą. Bez niego trafia do domyślnego obszaru roboczego.

Nagłówek żądania
X-Workspace-Id: ag_02k7m

Obszar roboczy niedostępny dla wywołującego zwraca 403 z kodem workspace_access_denied i odrzuconym workspaceId. Klucz API należy do jednego obszaru roboczego, więc otrzymuje ten sam błąd 403 dla id każdego innego: należy wysłać id jego własnego obszaru roboczego lub pominąć nagłówek.

403 Forbidden: brak dostępu do obszaru roboczego
{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "workspace_access_denied",
  "workspaceId": "ag_03p4r",
  "message": "You have no access to workspace ag_03p4r. Call GET /workspaces to list the workspaces you can use, and send one of those ids in the X-Workspace-Id header."
}

Utwórz obszar roboczy

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

Tworzy obszar roboczy w organizacji. Każdy właściciel i administrator organizacji zostaje jego administratorem.

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

W chwili wywołania twórca klucza musi być też właścicielem lub administratorem organizacji. W przeciwnym razie wywołanie zwraca 403 permission_denied.

Treść żądania

ParametrTypOpis
nameWYMAGANEstringOd 1 do 100 znaków, bez < ani >. Żaden inny obszar roboczy w organizacji nie może mieć tej nazwy.
descriptionstringDo 500 znaków, bez < ani >.
connectionLimitnumberOd 0 do 10000. Maksymalna liczba kont społecznościowych, które obszar roboczy może połączyć. Pominięcie oznacza brak limitu.

Zwraca 201 z nowym obszarem roboczym. Nieprawidłowa treść żądania lub nazwa, którą ma już inny obszar roboczy w organizacji, zwraca 400. Plan bez miejsca na kolejny obszar roboczy zwraca 403 subscription_required.

Odpowiedź 201
{
  "id": "ag_04q8s",
  "name": "Client C",
  "description": "Retail client",
  "organizationId": "org_01hzq",
  "isDefault": false,
  "connectionLimit": 10,
  "createdAt": "2026-11-18T10:00:00.000Z"
}
PoleOpis
idID nowego obszaru roboczego. Wysłane w X-Workspace-Id powoduje działanie w tym obszarze.
nameNazwa obszaru roboczego.
descriptionOpis lub null.
organizationIdOrganizacja będąca właścicielem obszaru roboczego.
isDefaultCzy jest to domyślny obszar roboczy organizacji.
connectionLimitMaksymalna liczba kont społecznościowych, które obszar roboczy może połączyć, lub null, gdy nie ma limitu.
createdAtKiedy utworzono obszar roboczy.

Usuń obszar roboczy

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

Usuwa obszar roboczy organizacji wraz z całą jego zawartością: postami, kanałami, elementami skrzynki, kluczami API i linkami do połączenia. Tej operacji nie można cofnąć.

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

W chwili wywołania twórca klucza musi być też właścicielem lub administratorem organizacji. W przeciwnym razie wywołanie zwraca 403 permission_denied.

Zwraca 200 z { "success": true }. Nie można usunąć domyślnego obszaru roboczego, ostatniego obszaru roboczego organizacji ani obszaru, który nadal ma połączone konta społecznościowe; każdy z tych przypadków zwraca 400. Najpierw należy usunąć konta. Id, które nie jest obszarem roboczym organizacji, zwraca 404.

Wskazówka dla agentów: przed usunięciem należy podać nazwę obszaru roboczego i uzyskać zgodę użytkownika. Usuniętego obszaru roboczego nie można przywrócić.

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.

Lista obszarów roboczych
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/workspaces \
  --header 'Authorization: Bearer <api-key>'
Działanie w innym obszarze roboczym
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts \
  --header 'Authorization: Bearer <oauth-token>' \
  --header 'X-Workspace-Id: ag_02k7m'
Utworzenie obszaru roboczego
curl --request POST \
  --url https://post.adaptlypost.com/post/api/v1/workspaces \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Client C", "description": "Retail client", "connectionLimit": 10 }'
Usunięcie obszaru roboczego
curl --request DELETE \
  --url https://post.adaptlypost.com/post/api/v1/workspaces/ag_04q8s \
  --header 'Authorization: Bearer <api-key>'
200
{
  "workspaces": [
    {
      "id": "ag_01j9x",
      "name": "Acme",
      "organization": { "id": "org_01hzq", "name": "Acme Agency" },
      "role": { "key": "editor", "name": "Editor" },
      "permissions": ["workspace.read", "posts.read", "accounts.read", "posts.draft", "media.upload", "analytics.read", "ai.generate", "members.read", "tokens.own", "posts.others", "posts.schedule", "posts.publish", "posts.delete", "analytics.sync", "webhooks.read", "webhooks.manage", "signature.manage", "flowsery.write", "redreplier.write", "claw.use"],
      "isDefault": true,
      "current": true,
      "can": { "draft": true, "schedule": true, "publish": true }
    },
    {
      "id": "ag_02k7m",
      "name": "Client B",
      "organization": { "id": "org_02abc", "name": "Client B Inc" },
      "role": { "key": "contributor", "name": "Contributor" },
      "permissions": ["workspace.read", "posts.read", "accounts.read", "posts.draft", "media.upload", "analytics.read", "ai.generate", "members.read", "tokens.own"],
      "isDefault": false,
      "current": false,
      "can": { "draft": true, "schedule": false, "publish": false }
    }
  ]
}