Retrieve Roles

Retrieve all available roles on a document or binder and the users and groups assigned to them.

Documents:

GET/api/{version}/objects/documents/{doc_id}/roles

Binders:

GET/api/{version}/objects/binders/{binder_id}/roles

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{doc_id}`	The document `id` field value.
`{binder_id}`	The binder `id` field value.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v17.1/objects/documents/245/roles

Response (abridged)

{
    "responseStatus": "SUCCESS",
    "responseMessage": "Document roles retrieved",
    "errorCodes": null,
    "documentRoles": [
        {
            "name": "reviewer__v",
            "label": "Reviewer",
            "assignedUsers": [
                25496,
                26231
            ],
            "assignedGroups": [
                1,
                2
            ],
            "availableUsers": [
                25496,
                26231,
                28874
            ],
            "availableGroups": [
                1,
                2,
                3
            ],
            "defaultUsers": [
                25496,
                26231
            ],
            "defaultGroups": [
                1,
                2
            ]
        },
        {
            "name": "viewer__v",
            "label": "Viewer",
        },
        {
            "name": "consumer__v",
            "label": "Consumer",
        },
        {
            "name": "approver__v",
            "label": "Approver",
        },
        {
            "name": "owner__v",
            "label": "Owner",
        },
        {
            "name": "editor__v",
            "label": "Editor",
        },
        {
            "name": "coordinator__v",
            "label": "Coordinator",
        }
    ],
    "errorType": null
}

Response Details

In the abridged response above, document ID 245 is configured with several roles. Two users (25496 & 26231) and two groups (1 & 2) are assigned to the reviewer__v role by default.