API Documentation

API Endpoint

Permission Sets

Permission Sets

The Permission Set object represents a set of permissions that can be assigned to a user.

You can find out more about permission sets in our Help documentation: Permission Sets

GET /api/v2/roles
Requestsreturns roles

GET  /api/v2/roles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "7680",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1831"
          }
        }
      }
    },
    {
      "id": "7681",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 0,
        "permissions": {},
        "editable_by_user": true,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1831"
          }
        }
      }
    },
    {
      "id": "7682",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 0,
        "permissions": {},
        "editable_by_user": true,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1831"
          }
        }
      }
    },
    {
      "id": "7683",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 0,
        "permissions": {},
        "editable_by_user": true,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1831"
          }
        }
      }
    },
    {
      "id": "7684",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 0,
        "permissions": {},
        "editable_by_user": true,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1831"
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/roles?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/roles?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 5,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get permission sets
GET/api/v2/roles

GET /api/v2/roles/1
Requestsreturns role

GET  /api/v2/roles/7686

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "7686",
    "type": "roles",
    "attributes": {
      "base_role_id": 3,
      "description": "test description",
      "name": "test_role",
      "people_count": 0,
      "permissions": {},
      "editable_by_user": true,
      "user_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1832"
        }
      }
    }
  },
  "meta": {}
}

Gets a permission set
GET/api/v2/roles/{id}

URI Parameters
HideShow
id
number (required) Example: 1

role id

Generated by aglio on 16 Aug 2025