Projects

Get project sharing

Changed on

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/projects/{projectId}/sharing

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/projects/{projectId}/sharing
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier

Example:prj_abc123

Response

Sharing state returned.

project_idstring required

Project identifier

workspace_idstring required

Workspace identifier

sharing_mode'restricted' | 'view' | 'edit' required

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

is_privateboolean required

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

can_manage_sharingboolean required

Whether the authenticated user may change this project's sharing

canvas_urlstring uri required

Project canvas URL

Example response

{
  "project_id": "prj_abc123",
  "workspace_id": "ws_abc123",
  "owner": {
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "members": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "role": "editor"
    }
  ]
}

Changes

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • info

      endpoint added