v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
user_permissions

List user permissions for a collection

Lists user permissions for the matching collection.

get/collections/{collection_id}/user_permissions

Query parameters

pageinteger

Set this to a positive, non-zero integer representing the page number of the results you want.

perinteger

Set this pagination parameter to the maximum number of results you want to receive back from your request.

Response

User permissions for the matching collection.

Example response

{
  "data": [
    {
      "id": "p2f0ou-3geb4w-123456",
      "relationships": {
        "user": {
          "id": "p0v24p-g7jy9k-123456"
        },
        "permissible": {
          "id": "oqgkkd-fr5iv4-hh142d"
        }
      }
    }
  ],
  "included": [
    {
      "id": "p0v24p-g7jy9k-123456",
      "attributes": {
        "email": "jane.doe@smartsheet.com",
        "first_name": "Jane",
        "last_name": "Doe"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}