PapermarkDocs
APIReferenceDatarooms

List dataroom groups

Paginated list of viewer groups in a dataroom. Groups define an audience (members by email or domain) and per-item view/download permissions, and are the target of group share links.

GET
/v1/datarooms/{id}/groups

Authorization

bearerAuth datarooms.read
AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: datarooms.read

Path Parameters

id*string

Query Parameters

limit?integer
Default25
Range1 <= value <= 100
cursor?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.papermark.com/v1/datarooms/string/groups"
{
  "data": [
    {
      "id": "clxgrp1234567890",
      "object": "dataroom_group",
      "name": "Investors",
      "allow_all": true,
      "domains": [
        "@acme.com"
      ],
      "member_count": 12,
      "link_count": 2,
      "dataroom_id": "clxy9abc1234567890",
      "created": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}
{
  "error": {
    "code": "bad_request",
    "message": "The request body is not valid JSON.",
    "doc_url": "https://www.papermark.com/docs/api/errors#bad_request",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token. Include an `Authorization: Bearer <token>` header.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Token is missing required scope: links.write.",
    "doc_url": "https://www.papermark.com/docs/api/errors#forbidden",
    "details": null
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Link link_abcd1234 not found.",
    "doc_url": "https://www.papermark.com/docs/api/errors#not_found",
    "details": null
  }
}
{
  "error": {
    "code": "unprocessable_entity",
    "message": "Invalid request body.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unprocessable_entity",
    "details": {
      "formErrors": [],
      "fieldErrors": {
        "expires_at": [
          "Invalid datetime"
        ]
      }
    }
  }
}
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 30s.",
    "doc_url": "https://www.papermark.com/docs/api/errors#rate_limit_exceeded",
    "details": null
  }
}

Move a dataroom folder

Reparent a folder within a dataroom. Refuses moves into the folder itself or one of its descendants, and refuses if the target parent already has a sibling with the same slug. Descendant `path`s are rewritten in a single transaction.

Create a dataroom group

Create a viewer group in a dataroom. Add members via POST /v1/datarooms/{id}/groups/{gid}/members, grant document/folder access via PUT .../permissions, then share it by creating a link with `audience_type: "group"`.