REST APIGET

Espacios de trabajo

Lista los espacios de trabajo en los que puede actuar una clave de API o un inicio de sesión OAuth, con el rol y las posibilidades en cada uno, y elige uno por petición con la cabecera X-Workspace-Id.

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

Lista los espacios de trabajo en los que puede actuar la clave o el inicio de sesión OAuth que llama, con tu rol y lo que puedes hacer en cada uno. Cualquier clave válida puede llamarlo, sea cual sea su rol.

Clave API (token Bearer)
Permiso:cualquier clave válidaRoles y permisos

Cuándo llamarlo

Llámalo cuando arranque una integración, antes de que lea o escriba nada. Una conexión OAuth, como el conector de Claude o ChatGPT, llega a todos los espacios de trabajo a los que pertenece su miembro, en todas sus organizaciones. Una clave de API solo llega a su propio espacio de trabajo, así que la lista tiene una entrada.

Si eres un agente: cuando la lista tenga más de un espacio de trabajo y el usuario no haya nombrado ninguno, pregunta cuál usar. Después envía su id en X-Workspace-Id en cada llamada, y lee su can antes de ofrecer programar o publicar.

Campos de la respuesta

CampoDescripción
idEl ID del espacio de trabajo. Envíalo en la cabecera X-Workspace-Id para actuar en este espacio de trabajo.
nameEl nombre del espacio de trabajo.
organizationLa organización propietaria del espacio de trabajo, con su id y name.
roleTu rol en este espacio de trabajo: key es admin, editor, contributor o viewer; name es la etiqueta en tu idioma. Para una clave de API, el rol de la clave.
isDefaultTrue para el espacio de trabajo al que llega una llamada que no envía la cabecera X-Workspace-Id.
currentTrue para el espacio de trabajo al que llegó esta llamada.
canTres booleanos, draft, schedule y publish, para lo que tu rol permite hacer con las publicaciones en este espacio de trabajo.

Elegir un espacio de trabajo con X-Workspace-Id

Todos los endpoints aceptan la cabecera opcional X-Workspace-Id. Ponle un id de esta lista y la llamada se ejecuta en ese espacio de trabajo, con tu rol allí. Sin ella, la llamada llega al espacio de trabajo predeterminado.

Cabecera de la petición
X-Workspace-Id: ag_02k7m

Un espacio de trabajo al que quien llama no tiene acceso responde 403 con code workspace_access_denied y el workspaceId rechazado. Una clave de API pertenece a un solo espacio de trabajo, así que recibe el mismo 403 con el id de cualquier otro: envía el id de su propio espacio de trabajo o quita la cabecera.

403 Prohibido: acceso al espacio de trabajo denegado
{
  "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."
}
Listar tus espacios de trabajo
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/workspaces \
  --header 'Authorization: Bearer <api-key>'
Actuar en otro espacio de trabajo
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts \
  --header 'Authorization: Bearer <oauth-token>' \
  --header 'X-Workspace-Id: ag_02k7m'
200
{
  "workspaces": [
    {
      "id": "ag_01j9x",
      "name": "Acme",
      "organization": { "id": "org_01hzq", "name": "Acme Agency" },
      "role": { "key": "editor", "name": "Editor" },
      "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" },
      "isDefault": false,
      "current": false,
      "can": { "draft": true, "schedule": false, "publish": false }
    }
  ]
}