---
updatedAt: 2026-06-15T13:51:20.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/llms.txt
---

# Retrieve Packages

Retrieves packages

> 📋 **Required privilege:** Read Packages

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.33.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v1/packages": {
      "get": {
        "tags": [
          "packages"
        ],
        "summary": "Retrieve Packages",
        "description": "Retrieves packages\n\n> 📋 **Required privilege:** Read Packages",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/page-size"
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "id:asc"
              ]
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, fileName, packageName, categoryId, info, notes, manifestFileName, cloudTransferStatus. Default filter is an empty query and returns all results from the requested page.",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackagesSearchResults"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read Packages"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Package": {
        "required": [
          "categoryId",
          "fileName",
          "fillUserTemplate",
          "osInstall",
          "packageName",
          "priority",
          "rebootRequired",
          "suppressEula",
          "suppressFromDock",
          "suppressRegistration",
          "suppressUpdates"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "example": "1"
          },
          "packageName": {
            "type": "string",
            "example": "Google Chrome"
          },
          "fileName": {
            "type": "string",
            "example": "my-package.pkg"
          },
          "categoryId": {
            "type": "string",
            "example": "-1"
          },
          "info": {
            "type": "string",
            "nullable": true,
            "example": "A package that is important to my organization."
          },
          "notes": {
            "type": "string",
            "nullable": true,
            "example": "Some notes."
          },
          "priority": {
            "type": "integer",
            "example": 3
          },
          "osRequirements": {
            "type": "string",
            "nullable": true,
            "example": "10.6.8, 10.7.x"
          },
          "fillUserTemplate": {
            "type": "boolean",
            "example": false
          },
          "indexed": {
            "type": "boolean",
            "readOnly": true,
            "example": false
          },
          "fillExistingUsers": {
            "type": "boolean",
            "example": false
          },
          "swu": {
            "type": "boolean",
            "example": false
          },
          "rebootRequired": {
            "type": "boolean",
            "example": false
          },
          "selfHealNotify": {
            "type": "boolean",
            "example": false
          },
          "selfHealingAction": {
            "type": "string",
            "nullable": true,
            "example": "nothing"
          },
          "osInstall": {
            "type": "boolean",
            "example": false
          },
          "serialNumber": {
            "type": "string",
            "nullable": true,
            "example": "1234"
          },
          "parentPackageId": {
            "type": "string",
            "nullable": true,
            "example": "3"
          },
          "basePath": {
            "type": "string",
            "nullable": true,
            "example": "my/path"
          },
          "suppressUpdates": {
            "type": "boolean",
            "example": false
          },
          "cloudTransferStatus": {
            "type": "string",
            "readOnly": true,
            "example": "READY"
          },
          "ignoreConflicts": {
            "type": "boolean",
            "example": false
          },
          "suppressFromDock": {
            "type": "boolean",
            "example": false
          },
          "suppressEula": {
            "type": "boolean",
            "example": false
          },
          "suppressRegistration": {
            "type": "boolean",
            "example": false
          },
          "installLanguage": {
            "type": "string",
            "nullable": true,
            "example": "en_US"
          },
          "md5": {
            "type": "string",
            "nullable": true,
            "example": "0cc175b9c0f1b6a831c399e269772661"
          },
          "sha256": {
            "type": "string",
            "nullable": true,
            "example": "61be55a8e2f6b4e172338bddf184d6dbee29c98853e0a0485ecee7f27b9af0b4"
          },
          "sha3512": {
            "type": "string",
            "nullable": true,
            "example": "a51a01e63f76c4601a2989575280e2a1c1e83191382277906b0f92a251c53bbbd1d9804dd30edd304cffe75d1c6455440b0c39081ca94c68f149d1f719e15092"
          },
          "hashType": {
            "type": "string",
            "nullable": true,
            "example": "MD5"
          },
          "hashValue": {
            "type": "string",
            "nullable": true,
            "example": "0cc175b9c0f1b6a831c399e269772661"
          },
          "size": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "example": "234KB"
          },
          "osInstallerVersion": {
            "type": "string",
            "nullable": true,
            "example": "10.3.x"
          },
          "manifest": {
            "type": "string",
            "nullable": true,
            "example": "manifest"
          },
          "manifestFileName": {
            "type": "string",
            "nullable": true,
            "example": "manifest.plist"
          },
          "format": {
            "type": "string",
            "nullable": true,
            "example": "format"
          }
        }
      },
      "PackagesSearchResults": {
        "type": "object",
        "properties": {
          "totalCount": {
            "type": "integer",
            "example": 1
          },
          "results": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Package"
            }
          }
        }
      }
    },
    "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": {}
          }
        }
      }
    }
  }
}
```