Get project guest access settings

Returns the master guest-access switch and documentation publication override for one project.

Effective documentation mode is the project override when set, otherwise the organization default. Hidden is the secure default. This setting filters what organization members can read. It does not grant project access or documentation-management permission.

GET/projects/{id}/guest-access

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

effectiveGuestDocumentationVisibilitystringrequired

Resolved mode: project override if set, otherwise the organization default.

Allowed:HiddenAllPagesSelectedPages

effectiveSourcestringrequired

Whether the effective mode comes from this project or the organization.

Allowed:projectorganization

guestAccessbooleanrequired

Master switch for organization-member access to this project. When false, members cannot open the project. Documentation visibility can still be prepared.

guestDocumentationVisibilitystring | nullrequired

Project override for guest documentation publication. Null inherits the organization default.

Allowed:HiddenAllPagesSelectedPages

idstring<uuid>required

organizationGuestDocumentationVisibilitystringrequired

Organization default used when the project override is null.

Allowed:HiddenAllPagesSelectedPages

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X GET "https://leadtime.app/api/public/projects/string/guest-access" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/string/guest-access", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/string/guest-access",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "effectiveGuestDocumentationVisibility": "Hidden",
  "effectiveSource": "project",
  "guestAccess": true,
  "guestDocumentationVisibility": "Hidden",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationGuestDocumentationVisibility": "Hidden"
}