GoliathDevelopersGet an API key
Reference/Spacesgenerated from the gateway manifest

getSpaceAccessList

A folder or file's audience.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

A folder or file's audience (ORGANIZATION = everyone in the org, OWNER = the owner of My files, RESTRICTED = only people granted access, here or on a parent folder, SYSTEM = everyone, read-only) and the people shared on THIS item directly, with their role. Grants on a parent folder also reach it and are NOT listed: for a full audit, read each ancestor folder's access list too. Needs view access.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getSpaceAccessList",
    "variables": {
      "itemId": "<itemId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.spaces.getSpaceAccessList({
  itemId: '<itemId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getSpaceAccessList',
    variables: {
      itemId: '<itemId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

itemIdID!required

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "spacesQuery": {
      "accessList": {
        "item": {
          "id": "<ID>",
          "name": "…",
          "accessMode": "INHERIT"
        },
        "audience": "ORGANIZATION",
        "entries": [
          {
            "person": {
              "id": "<ID>",
              "name": "…",
              "email": "…"
            },
            "role": "VIEWER",
            "isOwner": true
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistSpaceRootsREADlistSpaceFolderREADgetSpaceItemREADsearchSpaceItemsREADgetSpaceTextContentREADgetSpaceTextLines