Sessions

List a session's shares

Changed on

List everyone a session is shared with read-only — both registered recipients and pending email invitations. Reports and systematic reviews can also have editors or reviewers added in the Elicit web app; those higher-permission collaborators are not returned here. This list is not a complete permission inventory: DELETE by email can revoke those unlisted higher-permission shares too. Only the session owner can list shares.

Example

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

Request

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

Path parameters

sessionIdstring uuid required

The session ID (UUID) returned by the create endpoints and GET /sessions

Example:5ad08bfb-cbe0-4911-a8c3-309760d33029

Response

The session's current read-only shares.

sessionIdstring required

Unique identifier for the session.

urlstring required

URL to view the session in the Elicit web interface. Available actions depend on your permissions.

Example response

{
  "shares": [
    {
      "email": "colleague@example.com"
    }
  ]
}

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