PRproductive
Agent Roles

Get an agent role

Changed on

Returns the role associated with the specified agent, including its permission settings.

get/api/v2/agent_roles/{id}

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/agent_roles/{id}
  • Auth
    none declared

Path parameters

idstring required

The unique identifier of the agent role to retrieve.

Response

Single role

Example response

{
  "data": {
    "id": "5",
    "type": "roles",
    "attributes": {
      "name": "Project Manager",
      "description": "Can manage projects, budgets, and team members",
      "base_role_id": 2,
      "people_count": 8,
      "active_users_count": 6,
      "inactive_users_count": 2,
      "active_agents_count": 0,
      "inactive_agents_count": 0,
      "editable_by_user": true,
      "user_type_id": 1,
      "permissions": {
        "manage_projects": true,
        "manage_budgets": true,
        "view_financials": false
      }
    }
  },
  "included": []
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the // response's property type changed from string to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    This list may be incomplete.