For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get project sharing

Get project sharing with the FLORA API: GET /projects/{projectId}/sharing.

Returns how the project is shared: the link sharing mode, the active share link (only when the authenticated user may manage sharing), the owner, and everyone with a seat on the project. Missing and inaccessible projects both return 404.

GET https://app.flora.ai/api/v1/projects/{projectId}/sharing
  • Auth: API key as a bearer token, Authorization: Bearer $FLORA_API_KEY. See Authentication.

  • TypeScript SDK: client.projects.sharing.get().

  • Operation ID: getProjectSharing.

Example

curl -X GET 'https://app.flora.ai/api/v1/projects/prj_abc123/sharing' \
  -H "Authorization: Bearer $FLORA_API_KEY"
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const sharing = await client.projects.sharing.get({
  projectId: 'prj_abc123',
});
console.log(sharing);

Path parameters

Name
Type
Required
Description

projectId

string

Yes

Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.

Responses

200: Sharing state returned.

Field
Type
Required
Description

project_id

string

Yes

Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.

workspace_id

string

Yes

Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.

sharing_mode

string

Yes

Link sharing mode: restricted (no links; members only), view (anyone with the link can view), edit (anyone with the link can edit). One of: restricted, view, edit.

is_private

boolean

Yes

True when only the owner and the people it was shared with can see the project, rather than the whole workspace

can_manage_sharing

boolean

Yes

Whether the authenticated user may change this project's sharing

link

object or null

Yes

The active share link. Null when sharing is restricted, no link has been created yet, or the caller may not manage sharing.

link.url

string (uri)

Yes

Link into the project. Anyone who has it gets the link's role, so treat it as a secret.

link.role

string

Yes

What the link grants: guest can view (and comment when allowed), editor can edit. One of: guest, editor.

link.allow_comments

boolean

Yes

Whether visitors arriving through the link may leave comments

link.passphrase_protected

boolean

Yes

Whether visitors must enter a passphrase before the link resolves. The passphrase itself is never returned.

owner

object

Yes

Project owner

owner.name

string

Yes

Display name. Example: Ada Lovelace.

owner.email

string

Yes

Email address. Example: [email protected].

members

array of objects

Yes

People with a seat on the project besides the owner

members[].name

string

Yes

Display name. Example: Ada Lovelace.

members[].email

string

Yes

Email address. Example: [email protected].

members[].role

string

Yes

Role on the project. Example: editor.

canvas_url

string (uri)

Yes

Project canvas URL

Errors

Every error has the same body: error.code, error.message, and error.fields on validation errors. See Errors for how to recover from each code.

Status
Code
Meaning

400

invalid_json, input_validation_error

The body isn't valid JSON, or an input failed validation (fields lists each one).

401

unauthorized, invalid_api_key

The API key is missing, invalid or revoked.

402

insufficient_credits

The workspace balance is too low for this request.

403

forbidden, paid_plan_required

The key can't do this, or the workspace plan doesn't include it.

404

not_found

The resource doesn't exist or isn't visible to this key.

409

idempotency_duplicate, revision_conflict

Duplicate Idempotency-Key or a stale base_revision.

429

rate_limited

Too many requests. Back off and retry.

500

unknown_error, internal_error

Something failed on FLORA's side. Retry with backoff.

503

temporarily_unavailable

Authorization is temporarily unavailable. Retry later.

Last updated

Was this helpful?