Lista obszarów roboczych
Wyświetl obszary robocze, w których mogą działać poświadczenia RedReplier, wraz z rolą i uprawnieniami w każdym z nich.
https://ai.redreplier.com/ai-app/api/v1/workspacesWyświetl obszary robocze, w których mogą działać poświadczenia RedReplier, wraz z rolą i uprawnieniami w każdym z nich.
Uwierzytelnianie
Wyślij token API RedReplier lub token dostępu OAuth jako token Bearer. Ten endpoint jest dostępny dla każdego ważnego klucza.
Authorization: Bearer redreplier_test_1234567890
Content-Type: application/jsonParametry
Ten endpoint nie przyjmuje parametrów ścieżki ani zapytania.
Treść żądania
Ten endpoint nie wymaga treści JSON.
Odpowiedź
Zwraca obiekt z tablicą workspaces.
workspaces(Workspace[]): Obszary robocze, w których mogą działać te poświadczenia.
Obiekt Workspace
id(string): Identyfikator obszaru roboczego. Wyślij go w nagłówkuX-Workspace-Id, aby działać w tym obszarze roboczym.name(string): Nazwa obszaru roboczego.organization({ id, name }): Organizacja, do której należy obszar roboczy.role({ key, name }): Twoja rola w tym obszarze roboczym.keytoadmin,editor,contributorlubviewer.permissions(string[]): Klucze uprawnień, które masz w tym obszarze roboczym, na przykładredreplier.write.isDefault(boolean): Wartość true dla obszaru roboczego, do którego trafia wywołanie bez nagłówkaX-Workspace-Id.current(boolean): Wartość true dla obszaru roboczego, w którym wykonano to wywołanie.
Przykładowe żądanie
curl -s https://ai.redreplier.com/ai-app/api/v1/workspaces \
-H 'Authorization: Bearer redreplier_test_1234567890'Uwagi
Logowanie OAuth, na przykład przez konektor Claude lub ChatGPT, daje dostęp do wszystkich obszarów roboczych, do których należy dana osoba, we wszystkich organizacjach. Klucz API ma dostęp tylko do własnego obszaru roboczego, więc lista zawiera jedną pozycję. Obszar roboczy wybierzesz, wysyłając jego id w nagłówku X-Workspace-Id w dowolnym innym żądaniu.
Błędy
401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albocode: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.403 Forbidden:code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API,code: "workspace_access_denied", gdyX-Workspace-Idwskazuje obszar roboczy niedostępny dla tych poświadczeń, lubcode: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnieniaredreplier.write(mają je Administrator i Edytor).429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną wRetry-After.500 Internal Server Error: Nieoczekiwany błąd serwera.
curl --request GET \
--url https://ai.redreplier.com/ai-app/api/v1/workspaces \
--header 'Authorization: Bearer redreplier_test_1234567890'{
"workspaces": [
{
"id": "acct_7dK9pQ2",
"name": "Acme CRM",
"organization": { "id": "org_01J8ZK4M2Q", "name": "Acme" },
"role": { "key": "editor", "name": "Editor" },
"permissions": ["workspace.read", "redreplier.write"],
"isDefault": true,
"current": true
},
{
"id": "acct_3Hm8XwR",
"name": "Northwind",
"organization": { "id": "org_01J9P7T3XB", "name": "Northwind Studio" },
"role": { "key": "viewer", "name": "Viewer" },
"permissions": ["workspace.read"],
"isDefault": false,
"current": false
}
]
}