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

Read a Space's external access

Read-only metadata for one Space in the current family of a parent on an Enterprise or Internal plan. Requires parent admin authority and Space read access. Returns at most 100 links, passwords and people per section, with explicit truncation. Does not return sharing URLs, password proofs, connector credentials or private account identities.

GET/v1/teams/{teamId}/external-access/{spaceId}
Authorization
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
min length 1
spaceIdstringrequired
min length 1
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
spaceobjectrequired
Show properties
idstringrequired
slugstringrequired
titlestringrequired
liveUrlstring<uri> | nullrequired

Saved public site URL, without access credentials. Does not verify reachability.

Show properties
Any of:
string<uri>
string<uri>
null
null
teamobjectrequired
Show properties
idstringrequired
namestringrequired
slugstringrequired
parentTeamIdstring | nullrequired
publicAccessobjectrequired
Show properties
kindstringrequired

Public-grant reach for the live channel. Unknown means the frozen configuration is unavailable. Private does not exclude links, passwords or named access.

Allowed:publiclimitedscopedprivateunknown
opensAtstring | nullrequired
searchIndexingstringrequired

On when known public reach meets no noindex from the Space or its team, so search engines may list the live site. Unknown when public reach is unknown and nothing sets noindex.

Allowed:onoffunknown
linksobjectrequired
Show properties
countnumberrequired

Currently active sharing links across configured live, version and branch targets.

usesnumberrequired

Sum of lifetime credential redemptions for the currently active links. Includes repeats and automation. Not clicks or visitor requests.

lastUsedAtstring | nullrequired

Latest recorded use among the currently active links; null when none is recorded.

nextExpirystring | nullrequired
passwordsnumberrequired
peoplenumberrequired

Accepted, non-revoked Space person records. Not a count of contractors or people outside the company.

pendingPeoplenumberrequired
identityAudiencesnumberrequired

Active, non-revoked external identity grants with remaining uses. Not a count of people.

servicesobjectrequired
Show properties
availablebooleanrequired

False when the feature, credential permissions or role metadata do not permit this read. Unavailable is not zero.

rolesobject[]required
Show properties
Array of object
rolestringrequired
connectorstring | nullrequired
contextstringrequired
Allowed:teamownervisitor
boundbooleanrequired

An active connection in the owning team is bound to this role. Does not verify provider authentication or health.

servingbooleanrequired

A serving grant is stored for the bound connection. This is not an effective connector-policy verdict or proof of data flow.

publicGrantsobject[]required
Show properties
Array of object
grantobjectrequired
Show properties
namestring
min length 1 · max length 120
audienceobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
teamIdstringrequired
min length 1 · max length 255
object
kindstringrequired
personIdstringrequired
min length 1 · max length 255
object
kindstringrequired
linkIdstringrequired
min length 1 · max length 255
object
kindstringrequired
credentialIdstringrequired
min length 1 · max length 255
object
kindstringrequired
machineIdstringrequired
min length 1 · max length 255
object
kindstringrequired
issuerstringrequired
min length 1 · max length 255
subjectstringrequired
min length 1 · max length 255
resourcesobjectrequired
Show properties
includestring[]required
min items 1 · max items 100
excludestring[]required
max items 100 · default: []
capabilitiesstring[]required
min items 1 · max items 5
constraintsobjectrequired
default: {}
Show properties
notBeforestring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
expiresAtstring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
maxUsesinteger
max 1000000
requireVerifiedEmailboolean
networkobject
Show properties
ipCidrsstring[]

IP address and CIDR Grants are unsupported because the serving runtime has no trusted visitor IP. Remove the IP constraint.

min items 1 · max items 50
countriesstring[]
min items 1 · max items 250
excludedCountriesstring[]
min items 1 · max items 250
excludedUserAgentSubstringsstring[]
min items 1 · max items 50
frameOriginstring
min length 1 · max length 2048
targetobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
versionIdstringrequired
min length 1 · max length 255
object
kindstringrequired
branchstringrequired
min length 1 · max length 255
object
kindstringrequired
idstringrequired
matches ^(grt_)[A-Za-z0-9]+$
sourceobjectrequired
Show properties
kindstringrequired
Allowed:configmanagedsystem
referencestringrequired
min length 1 · max length 255
generationintegerrequired
max 9007199254740991
statusstringrequired
Allowed:scheduledactiveexpired
sourceExplanationobjectrequired
Show properties
editablebooleanrequired
labelstringrequired
min length 1
detailstringrequired
min length 1
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
linksobject[]required

Newest 100 configured links, ordered by creation time and ID descending. See truncated.links for additional records.

Show properties
Array of object
idstringrequired
min length 1
spaceIdstringrequired
min length 1
grantIdstringrequired
min length 1
revisionintegerrequired
max 9007199254740991
namestringrequired
min length 1
landingPathstringrequired
min length 1 · max length 1024
resourcesobjectrequired
Show properties
includestring[]required
min items 1 · max items 100
excludestring[]required
max items 100 · default: []
capabilitiesstring[]required
min items 1
constraintsobjectrequired
Show properties
notBeforestring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
expiresAtstring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
maxUsesinteger
max 1000000
requireVerifiedEmailboolean
networkobject
Show properties
ipCidrsstring[]

IP address and CIDR Grants are unsupported because the serving runtime has no trusted visitor IP. Remove the IP constraint.

min items 1 · max items 50
countriesstring[]
min items 1 · max items 250
excludedCountriesstring[]
min items 1 · max items 250
excludedUserAgentSubstringsstring[]
min items 1 · max items 50
frameOriginstring
min length 1 · max length 2048
targetobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
versionIdstringrequired
min length 1 · max length 255
object
kindstringrequired
branchstringrequired
min length 1 · max length 255
object
kindstringrequired
createdBystring | nullrequired
openCountintegerrequired
min 0 · max 9007199254740991
lastUsedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
activebooleanrequired
passwordsobject[]required
Show properties
Array of object
idstringrequired
matches ^(pwd_)[A-Za-z0-9]+$
grantobjectrequired
Show properties
grantobjectrequired
Show properties
namestring
min length 1 · max length 120
audienceobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
teamIdstringrequired
min length 1 · max length 255
object
kindstringrequired
personIdstringrequired
min length 1 · max length 255
object
kindstringrequired
linkIdstringrequired
min length 1 · max length 255
object
kindstringrequired
credentialIdstringrequired
min length 1 · max length 255
object
kindstringrequired
machineIdstringrequired
min length 1 · max length 255
object
kindstringrequired
issuerstringrequired
min length 1 · max length 255
subjectstringrequired
min length 1 · max length 255
resourcesobjectrequired
Show properties
includestring[]required
min items 1 · max items 100
excludestring[]required
max items 100 · default: []
capabilitiesstring[]required
min items 1 · max items 5
constraintsobjectrequired
default: {}
Show properties
notBeforestring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
expiresAtstring<date-time> | string
Show properties
Any of:
string<date-time>
string<date-time>
string
string
maxUsesinteger
max 1000000
requireVerifiedEmailboolean
networkobject
Show properties
ipCidrsstring[]

IP address and CIDR Grants are unsupported because the serving runtime has no trusted visitor IP. Remove the IP constraint.

min items 1 · max items 50
countriesstring[]
min items 1 · max items 250
excludedCountriesstring[]
min items 1 · max items 250
excludedUserAgentSubstringsstring[]
min items 1 · max items 50
frameOriginstring
min length 1 · max length 2048
targetobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
versionIdstringrequired
min length 1 · max length 255
object
kindstringrequired
branchstringrequired
min length 1 · max length 255
object
kindstringrequired
idstringrequired
matches ^(grt_)[A-Za-z0-9]+$
sourceobjectrequired
Show properties
kindstringrequired
Allowed:configmanagedsystem
referencestringrequired
min length 1 · max length 255
generationintegerrequired
max 9007199254740991
statusstringrequired
Allowed:scheduledactiveexpired
sourceExplanationobjectrequired
Show properties
editablebooleanrequired
labelstringrequired
min length 1
detailstringrequired
min length 1
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
rotatedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
lastUsedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
activebooleanrequired
peopleobject[]required
Show properties
Array of object
idstringrequired
min length 1
spaceIdstringrequired
min length 1
displayNamestringrequired
min length 1 · max length 160
emailstring<email> | nullrequired
Show properties
Any of:
string<email>
string<email>
null
null
statusstringrequired
Allowed:pendingacceptedrevoked
grantsobject[]required
Show properties
Array of object
idstringrequired
min length 1
scopestringrequired
min length 1 · max length 1024
rolestringrequired
Allowed:viewercommentereditormanager
targetobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
versionIdstringrequired
min length 1 · max length 255
object
kindstringrequired
branchstringrequired
min length 1 · max length 255
object
kindstringrequired
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
invitedBystring | nullrequired
inviteExpiresAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
acceptedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
truncatedobjectrequired
Show properties
linksbooleanrequired
passwordsbooleanrequired
peoplebooleanrequired
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/external-access/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "$schema": "http://example.com",
  "data": {
    "space": {
      "id": "string",
      "slug": "string",
      "title": "string",
      "liveUrl": "http://example.com",
      "team": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "parentTeamId": "string"
      },
      "publicAccess": {
        "kind": "public",
        "opensAt": "string"
      },
      "searchIndexing": "on",
      "links": {
        "count": 0,
        "uses": 0,
        "lastUsedAt": "string",
        "nextExpiry": "string"
      },
      "passwords": 0,
      "people": 0,
      "pendingPeople": 0,
      "identityAudiences": 0,
      "services": {
        "available": true,
        "roles": [
          {
            "role": "string",
            "connector": "string",
            "context": "team",
            "bound": true,
            "serving": true
          }
        ]
      }
    },
    "publicGrants": [
      {
        "grant": {
          "name": "string",
          "audience": {
            "kind": "public"
          },
          "resources": {
            "include": [
              "string"
            ],
            "exclude": []
          },
          "capabilities": [
            "page.view"
          ],
          "constraints": {},
          "target": {
            "kind": "live"
          },
          "id": "string",
          "source": {
            "kind": "config",
            "reference": "string"
          }
        },
        "generation": 1,
        "status": "scheduled",
        "sourceExplanation": {
          "editable": true,
          "label": "string",
          "detail": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "links": [
      {
        "id": "string",
        "spaceId": "string",
        "grantId": "string",
        "revision": 1,
        "name": "string",
        "landingPath": "string",
        "resources": {
          "include": [
            "string"
          ],
          "exclude": []
        },
        "capabilities": [
          "page.view"
        ],
        "constraints": {
          "notBefore": "2019-08-24T14:15:22Z",
          "expiresAt": "2019-08-24T14:15:22Z",
          "maxUses": 1,
          "requireVerifiedEmail": true,
          "network": {
            "ipCidrs": [
              "string"
            ],
            "countries": [
              "st"
            ],
            "excludedCountries": [
              "st"
            ],
            "excludedUserAgentSubstrings": [
              "string"
            ]
          },
          "frameOrigin": "string"
        },
        "target": {
          "kind": "live"
        },
        "createdBy": "string",
        "openCount": 0,
        "lastUsedAt": "2019-08-24T14:15:22Z",
        "revokedAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "active": true
      }
    ],
    "passwords": [
      {
        "id": "string",
        "grant": {
          "grant": {
            "name": "string",
            "audience": {
              "kind": "public"
            },
            "resources": {
              "include": [
                "string"
              ],
              "exclude": []
            },
            "capabilities": [
              "page.view"
            ],
            "constraints": {},
            "target": {
              "kind": "live"
            },
            "id": "string",
            "source": {
              "kind": "config",
              "reference": "string"
            }
          },
          "generation": 1,
          "status": "scheduled",
          "sourceExplanation": {
            "editable": true,
            "label": "string",
            "detail": "string"
          },
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        },
        "rotatedAt": "2019-08-24T14:15:22Z",
        "lastUsedAt": "2019-08-24T14:15:22Z",
        "revokedAt": "2019-08-24T14:15:22Z",
        "active": true
      }
    ],
    "people": [
      {
        "id": "string",
        "spaceId": "string",
        "displayName": "string",
        "email": "user@example.com",
        "status": "pending",
        "grants": [
          {
            "id": "string",
            "scope": "string",
            "role": "viewer",
            "target": {
              "kind": "live"
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "revokedAt": "2019-08-24T14:15:22Z"
          }
        ],
        "invitedBy": "string",
        "inviteExpiresAt": "2019-08-24T14:15:22Z",
        "acceptedAt": "2019-08-24T14:15:22Z",
        "revokedAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ],
    "truncated": {
      "links": true,
      "passwords": true,
      "people": true
    }
  }
}

Was this page helpful?