---
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 a Volume Purchasing Location with the supplied id

Retrieves a Volume Purchasing Location with the supplied id

> 📋 **Required privilege:** Read Volume Purchasing Locations

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.32.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/volume-purchasing-locations/{id}": {
      "get": {
        "tags": [
          "volume-purchasing-locations"
        ],
        "summary": "Retrieve a Volume Purchasing Location with the supplied id",
        "description": "Retrieves a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Volume Purchasing Location identifier",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VolumePurchasingLocation"
                }
              }
            }
          },
          "404": {
            "description": "Volume Purchasing Location with that id does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read Volume Purchasing Locations"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiError": {
        "type": "object",
        "properties": {
          "httpStatus": {
            "type": "integer",
            "description": "HTTP status of the response",
            "example": 400
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiErrorCause"
            }
          }
        }
      },
      "ApiErrorCause": {
        "required": [
          "field"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error-specific code that can be used to identify localization string, etc.",
            "example": "8675309"
          },
          "field": {
            "type": "string",
            "description": "Name of the field that caused the error.",
            "example": "Name"
          },
          "description": {
            "type": "string",
            "description": "A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text",
            "example": "I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours"
          },
          "id": {
            "type": "string",
            "description": "id of object with error. Optional.",
            "nullable": true,
            "example": "3"
          }
        }
      },
      "VolumePurchasingContent": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true,
            "example": "Example Content"
          },
          "licenseCountTotal": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "licenseCountInUse": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "licenseCountReported": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "iconUrl": {
            "type": "string",
            "readOnly": true,
            "example": "https://is4-ssl.mzstatic.com/image/thumb/Purple113/v4/73/d4/73/73d47332-fefc-d350-2984-5b4a4755a502/AppIcon-0-1x_U007emarketing-0-0-GLES2_U002c0-512MB-sRGB-0-0-0-85-220-0-0-0-6.png/360x216bb.png"
          },
          "deviceTypes": {
            "type": "array",
            "readOnly": true,
            "items": {
              "type": "string",
              "example": "IOS",
              "enum": [
                "IOS",
                "MACOS",
                "TVOS"
              ]
            }
          },
          "contentType": {
            "type": "string",
            "readOnly": true,
            "example": "IOS_APP",
            "enum": [
              "IOS_APP",
              "MAC_APP",
              "BOOK",
              "UNKNOWN"
            ]
          },
          "pricingParam": {
            "type": "string",
            "readOnly": true,
            "example": "STDQ",
            "enum": [
              "STDQ",
              "PLUS",
              "Unknown"
            ]
          },
          "adamId": {
            "type": "string",
            "readOnly": true,
            "example": "748057890"
          }
        }
      },
      "VolumePurchasingLocation": {
        "allOf": [
          {
            "$ref": "#/components/schemas/VolumePurchasingLocationListView"
          },
          {
            "type": "object",
            "properties": {
              "content": {
                "type": "array",
                "readOnly": true,
                "items": {
                  "$ref": "#/components/schemas/VolumePurchasingContent"
                }
              }
            }
          }
        ]
      },
      "VolumePurchasingLocationListView": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Example Location"
          },
          "totalPurchasedLicenses": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "totalUsedLicenses": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "id": {
            "type": "string",
            "readOnly": true,
            "example": "1"
          },
          "appleId": {
            "type": "string",
            "readOnly": true,
            "example": "testUser@appleId.com"
          },
          "email": {
            "type": "string",
            "readOnly": true,
            "example": "testUser@email.com"
          },
          "organizationName": {
            "type": "string",
            "readOnly": true,
            "example": "Jamf"
          },
          "tokenExpiration": {
            "type": "string",
            "readOnly": true,
            "example": "2022-04-25T21:09:31.661Z"
          },
          "countryCode": {
            "type": "string",
            "description": "The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is located.",
            "readOnly": true,
            "example": "US"
          },
          "locationName": {
            "type": "string",
            "readOnly": true,
            "example": "Example Location"
          },
          "clientContextMismatch": {
            "type": "boolean",
            "description": "If this is \"true\", the clientContext used by this server does not match the clientContext returned by the Volume Purchasing API.",
            "readOnly": true,
            "example": false
          },
          "automaticallyPopulatePurchasedContent": {
            "type": "boolean",
            "example": false
          },
          "sendNotificationWhenNoLongerAssigned": {
            "type": "boolean",
            "example": false
          },
          "autoRegisterManagedUsers": {
            "type": "boolean",
            "example": false
          },
          "siteId": {
            "type": "string",
            "example": "1"
          },
          "siteName": {
            "type": "string",
            "example": "Example Name"
          },
          "lastSyncTime": {
            "type": "string",
            "readOnly": true,
            "example": "2022-09-25T21:09:31.661Z"
          }
        }
      }
    },
    "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": {}
          }
        }
      }
    }
  }
}
```