Get Workspace

Get a workspace's metadata and the caller's permission level. Returns 404 if the workspace is archived or the caller has no permission on it (the two cases are not distinguished for security).

GET/api/v1/workspaces/{id}

Authorization

apiKey
X-API-Key<token>

Your Recall API key (personal or workspace). Generate one from the Recall dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

Workspace ID.

Response Body

application/json

application/json

application/json

curl -X GET \  "https://tryrecall.com/api/v1/workspaces/wsp_abc123" \  -H "X-API-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "workspace": {
      "id": "wsp_abc123",
      "name": "Engineering",
      "slug": "engin3r2",
      "color": "#3972F6",
      "ownerId": "string",
      "organizationId": "string",
      "billedAccountUserId": "string",
      "allowPersonalApiKeys": true,
      "role": "admin",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "archivedAt": "2019-08-24T14:15:22Z"
    }
  }
}
{
  "error": "string"
}
Empty
{
  "error": "string"
}