---
updatedAt: 2026-02-12T21:01:17.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/v11.14.0/llms.txt
---

# Get the current Jamf API Roles

Get roles with Search Criteria

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.14.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v1/api-roles": {
      "get": {
        "tags": [
          "api-roles"
        ],
        "summary": "Get the current Jamf API Roles",
        "description": "Get roles with Search Criteria",
        "operationId": "getAllApiRoles",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/page-size"
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "id:asc"
              ]
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName==\"*myRole*\"",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of the current Jamf API Roles",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiRoleResult"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read API Roles"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiRole": {
        "required": [
          "displayName",
          "id",
          "privileges"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "example": "1"
          },
          "displayName": {
            "type": "string",
            "example": "One Role to Rule them all"
          },
          "privileges": {
            "minItems": 0,
            "type": "array",
            "items": {
              "type": "string",
              "example": "View License Serial Numbers"
            }
          }
        }
      },
      "ApiRoleResult": {
        "required": [
          "results",
          "totalCount"
        ],
        "type": "object",
        "properties": {
          "totalCount": {
            "minimum": 0,
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "results": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiRole"
            }
          }
        }
      }
    },
    "parameters": {
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "style": "form",
        "explode": true,
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "page-size": {
        "name": "page-size",
        "in": "query",
        "required": false,
        "style": "form",
        "explode": true,
        "schema": {
          "type": "integer",
          "default": 100
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "BasicAuth": {
        "type": "http",
        "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint",
        "scheme": "basic"
      },
      "ApiClient": {
        "type": "oauth2",
        "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-si-base": "swagger.json",
  "x-github-repo": "jamf/Jamf-Pro-API-Schema",
  "x-github-sha": "5f8b85a61ce288205f7b44d478a117fb1acea0c6"
}
```