Skip to navigation
API ReferenceGolinks

Audience Options

What access may choose from when making or changing a link: the workspace’s allow-list for go links and events, split into its own domains and partners’, and whether Google can be or already is required. Any member with a seat may read it, with a signed-in session as in the app’s form; a key needs golinks:read, not domains:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
domainslist of strings

The workspace’s allow-list: every domain access.domains may name. Empty, a DOMAIN link lets in members only.

claimedlist of strings

Those of domains that are the workspace’s own, verified and left on the list.

partnerslist of strings

Those of domains that are partners’ (/partner-domains).

googleAvailableboolean

Whether this deployment has Google sign-in, without which requireGoogle is stored false.

workspaceRequiresGoogleboolean

Whether the workspace already requires Google sign-in, which makes every link Google only whatever requireGoogle says.

Errors

402
Subscription Required Error
429
Too Many Requests Error