Skip to content
Docs
Esc
↑↓navigate↵open⌘Jpreview

Get the team's space access settings

Returns the access a new space in this team starts with, whether the team allows private spaces only, whether it hides every space from search engines, its effective outgoing transfer restriction and controlling parent, and how many of its spaces are public now.

GET/v1/teams/{teamId}/access/defaults
Authorization
AuthorizationBearer token · headerrequired

Space key (sfc_…) for an unclaimed anonymous Space. Also the fragment of its claim URL and the token of its /__/<key> door. A publish without a credential returns it in claim with the claim link. With the key, getSpace extends the Space's expiry window, getSpaceVersion follows its publish, createSpaceOpenLink returns its reusable open link, and restoreSpace undoes a deleteSpace while the claim window remains open.

or
AuthorizationBearer token · headerrequired

Better Auth session, OAuth access token, OAuth client-credentials token, or sfm_ Space machine credential.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.0 with explicit Spacefast capability scopes. Use the authorization-code flow for people and client credentials for machines.

Scopes:teams:read
Path parameters
teamIdstringrequired
Responses
200

Response for status 200

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

dataobjectrequired
Show properties
privateSpacesOnlybooleanrequired

When true, no space in this team can be public: public Grants, public new-space defaults, and access: public on create or publish are refused with team_private_spaces_only, and public access declared in sf.jsonc is ignored. Turning it on revokes every public Grant on the team's spaces and turns noindex on.

noindexbooleanrequired

When true, every space in this team serves platform noindex directives on its live hostnames, whatever its own noindex says, and a space cannot turn it off. Always true while privateSpacesOnly is true.

restrictSpaceTransferboolean

Whether outgoing Space transfers are restricted to the controlling parent team and its subteams. Absent on APIs without transfer-policy support; absence does not mean the rule is off.

spaceTransferPolicyobject
Show properties
inheritedbooleanrequired
eligiblebooleanrequired

Whether the parent has an Enterprise or Internal plan.

managedByobjectrequired
Show properties
idstringrequired
namestringrequired
slugstringrequired
newSpaceGrantPresetstringrequired

The general access a new space in this team starts with. private admits the whole team; public also admits anyone on the web. Never public while privateSpacesOnly is true.

Allowed:privatepublic
publicSpaceCountintegerrequired

How many of the team's spaces hold or declare public access. While privateSpacesOnly is off, the spaces turning it on makes private; while it is on, the spaces whose sf.jsonc declares access.public, which turning it off makes public again.

min 0 · max 9007199254740991
default

Problem details (RFC 9457). Any 4xx/5xx response is one application/problem+json document.

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

typestringrequired

Problem type URI resolving to the error docs page. The server derives it mechanically from code against the docs origin.

titlestringrequired

Short human-readable summary of the problem type. The server derives it mechanically from code.

statusintegerrequired

HTTP status code of this response, repeated in the body.

min -9007199254740991 · max 9007199254740991
detailstringrequired

Human-readable failure explanation for this occurrence.

codestringrequired

Stable snake_case error code naming the failed public contract.

pointerstring

RFC 6901 JSON Pointer into the failing request field, for example "/files/37/path", on validation failures.

detailsobject

Machine-readable context for the error code.

fixstring

One sentence on what to do about this error code, the same text as the type page. Read it before retrying.

suggestionsstring[]

Actionable recovery steps safe to show in dashboards, SDKs, and CLI output.

nextstring[]

Copy-pasteable commands or API requests an agent can run next.

requestIdstringrequired

The request id to quote when contacting support.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.spacefast.com/v1/teams/string/access/defaults' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "$schema": "http://example.com",
  "data": {
    "privateSpacesOnly": true,
    "noindex": true,
    "restrictSpaceTransfer": true,
    "spaceTransferPolicy": {
      "inherited": true,
      "eligible": true,
      "managedBy": {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    },
    "newSpaceGrantPreset": "private",
    "publicSpaceCount": 0
  }
}

Was this page helpful?