Sinatra Docs
API ReferenceAccess

List workspace access

Owner only.

Lists members, recent access requests and invitations. Invitation tokens and redemption secrets are never returned.

GET/v1/workspaces/{workspaceId}/access
AuthorizationBearer <token>

A personal access token, which starts with sntr_. Create one on the dashboard's CLI & API page (https://app.sinatra.dev/tokens). It acts as you in every workspace you belong to, with your role in each, and expires after at most 365 days. The CLI's browser sign-in sends an OAuth access token here instead.

In: header

Path Parameters

workspaceIdstring

The workspace's id, from GET /v1/me.

Response Body

curl -X GET "https://api.sinatra.dev/v1/workspaces/string/access"
{
  "memberships": [
    {
      "id": "string",
      "role": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "user": {
        "id": "string",
        "name": "string",
        "githubLogin": "string",
        "avatarUrl": "string"
      }
    }
  ],
  "accessRequests": [
    {
      "id": "string",
      "state": "string",
      "requestedAt": "2019-08-24T14:15:22Z",
      "reviewedAt": "2019-08-24T14:15:22Z",
      "assignedRole": "string",
      "requester": {
        "id": "string",
        "name": "string",
        "githubLogin": "string",
        "avatarUrl": "string"
      }
    }
  ],
  "invites": [
    {
      "id": "string",
      "email": "string",
      "role": "string",
      "status": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "revokedAt": "2019-08-24T14:15:22Z",
      "declinedAt": "2019-08-24T14:15:22Z",
      "acceptedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}