Help Center

Roles

A role is similar to an ordinary user. You can assign tasks to a role and use it in your workflows. Each role participant receives a task in their Inbox, and when at least one of them approves or declines the task, it is forwarded to the next stage.

You can find additional information about roles in the help section.

Methods

GET /roles

This method returns a list of roles in your organization.

GET https://api.pyrus.com/v4/roles

Response body

{
  "roles": [
    {
      "id": 32568,
      "name": "Accountant",
      "banned": false,
      "member_ids": [
        1233,
        1731,
        2384
      ]
    },
    {
      "id": 13355,
      "name": "Managers",
      "banned": false,
      "member_ids": [
        2384,
        1346,
        4444,
        3460
      ]
    }
  ]
}

curl

curl -X GET \
  'https://api.pyrus.com/v4/roles' \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json'

GET /roles/{id}

This method gives you a role details by ID.

GET https://api.pyrus.com/v4/roles/{id}

Response body

{
  "id": 32568,
  "name": "Accountant",
  "banned": false,
  "member_ids": [
    1233,
    1731,
    2384
   ]
}

curl

curl -X GET \
  'https://api.pyrus.com/v4/roles/<ROLE_ID>' \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json'

POST /roles

This method creates a role in the user's organization.

POST https://api.pyrus.com/v4/roles

Request body

{
  "name": "TechSupport",
  "member_add": [
    1732,
    4487
  ]
}

Response body

{
  "id": 9364,
  "name": "TechSupport",
  "banned": "false",
  "member_ids": [
    1732,
    4487
  ]
}

curl

curl -X POST \
  https://api.pyrus.com/v4/roles \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "TechSupport",
  "member_ids": [
    1732,
    4487
  ]
}'

Parameters

nameRole name.
member_addRole members. An array of person IDs.

PUT /roles/{role-id}

This method updates a role.

PUT https://api.pyrus.com/v4/roles/9364

Request body

{
  "name": "InternalTechSupport",
  "member_add": [
    3796
  ],
  "member_remove": [
    1732
  ],
  "banned": false
}

Response body

{
  "id": 9364,
  "name": "InternalTechSupport",
  "banned": "false",
  "member_ids": [
    3796,
    4487
  ]
}

curl

curl -X PUT \
  https://api.pyrus.com/v4/roles/9364 \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "InternalTechSupport",
  "member_add": [
    3796
  ],
  "member_remove": [
    1732
  ],
  "banned": false
}'

Parameters

nameRole name.
member_addAdded role members. An array of person IDs.
member_removeRemoved role members. An array of person IDs.
bannedBan/unban role.

Was this article helpful?