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

List external access

Read-only, paginated access metadata for a parent team on an Enterprise or Internal plan and its live children. Includes lightweight owning-team filter choices; read team defaults separately with listTeamExternalAccessTeams. Requires parent admin authority and Space read access. Space counts describe returned rows, not family totals. Filter scans are bounded; continue with nextCursor even after an empty page. Sharing URLs, credentials, private connection identities and traffic are excluded.

GET/v1/teams/{teamId}/external-access
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
Query parameters
limitinteger

Page size.

min 1 · max 100 · default: 20
cursorstring

Opaque cursor from the previous page's nextCursor.

min length 1 · max length 4096
qstring
max length 200
owningTeamIdstring
min length 1
accessstring

Filter known public reach, private (including scheduled) reach, active links, configured services, or search indexing on. Unknown reach remains visible under all.

default: "all"
Allowed:allpublicprivatescheduledlinksservicesindexed
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
spacesobject[]required
Show properties
Array of object
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.

scopeobjectrequired
Show properties
parentobjectrequired
Show properties
idstringrequired
namestringrequired
slugstringrequired
parentTeamIdstring | nullrequired
teamsobject[]required

Lightweight current-family identities for owning-team filter choices. Settings are read separately with pagination.

Show properties
Array of object
idstringrequired
namestringrequired
slugstringrequired
parentTeamIdstring | nullrequired
asOfstring<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))$
paginationobjectrequired
Show properties
nextCursorstring | nullrequired

Opaque cursor for the next page; null when there are no more results.

hasMorebooleanrequired

Whether another page exists after this one.

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "$schema": "http://example.com",
  "data": {
    "spaces": [
      {
        "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
            }
          ]
        }
      }
    ],
    "scope": {
      "parent": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "parentTeamId": "string"
      },
      "teams": [
        {
          "id": "string",
          "name": "string",
          "slug": "string",
          "parentTeamId": "string"
        }
      ]
    },
    "asOf": "2019-08-24T14:15:22Z"
  },
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}

Was this page helpful?