listCollaborators

GET

/v5/books/{bookId}/collaborators

List collaborators of the book

Parameters

Path Parameters

bookId

required

string

The id of the book. Same bookId url param on Bkper

Responses

200

A CollaboratorPayloadCollection response

An ordered list of Collaborator

object

items

Array<object>

object

agentId

The id of agent that created the resource

string

createdAt

The creation timestamp, in milliseconds

string

email

The email of the Collaborator

string

id

The unique id that identifies the Collaborator in the Book

string

permission

The permission the Collaborator has in the Book

string

Allowed values: OWNER EDITOR POSTER RECORDER VIEWER NONE

updatedAt

The last update timestamp, in milliseconds

string

Example

{
  "agentId": "string",
  "createdAt": "1592000000000",
  "email": "string",
  "id": "string",
  "permission": "OWNER",
  "updatedAt": "1592000000000"
}

Example

{
  "items": [
    {
      "agentId": "string",
      "createdAt": "1592000000000",
      "email": "string",
      "id": "string",
      "permission": "OWNER",
      "updatedAt": "1592000000000"
    }
  ]
}