Projects

List a project's shares

Changed on

Lists everyone the project is shared with individually, registered recipients and pending invitations alike, each at the role they actually hold. Owner-only.

shares lists individual shares only. organization is set when the project is also shared with an entire organization, which is done in the Elicit web interface; every active member of that organization holds the role it reports, and those members are not listed in shares unless they also hold an individual share of their own. A member who holds both is listed once, at the stronger of the two. organization is null when no organization currently reaches the project — including when a share exists but that organization's plan no longer includes sharing, since its members have no access.

Example

curl https://elicit.com/api/v2/projects/{projectId}/shares \
  -H "Authorization: Bearer elk_live_your_key_here"
get/projects/{projectId}/shares

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/projects/{projectId}/shares
  • Auth
    HTTP bearer

Path parameters

projectIdstring uuid required

The project ID (UUID) from GET /projects or POST /projects

Example:9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60

Response

The project's current shares.

projectIdstring uuid required

The project ID (UUID) from GET /projects or POST /projects

urlstring required

URL to open this project in the Elicit web interface.

Example response

{
  "projectId": "9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60",
  "shares": [
    {
      "email": "colleague@example.com"
    }
  ],
  "organization": {
    "name": "Acme Research"
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status