Don’t forget to include your authentication with each request. All results will return a JSON object with a meta field, containing system information about the query.

• GET /licenses
• GET /licenses/<id>
• POST /licenses

GET /licenses

Get the details of all licenses available. There is no pagination on this endpoint.

Parameters: None

Example Request

curl -X GET https://api.privacybee.com/licenses \
     -H "Content-Type: application/json"

Return: Array<License>

---

GET /licenses/<id>

Gets the details of a specific license

Variable	Data Type	Required	Description
id	unsigned integer	Yes	The unique identifier for the license.

Example Request

curl -X GET https://api.privacybee.com/licenses/123 \
     -H "Content-Type: application/json"

Return: License object

Example

{
  "name": "Scan & Delete",
  "id": "scan_delete",
  "price": 1900,
  "currency": "USD",
  "num_active": 1580,
  "num_assigned": 1550,
  "num_available": 30,
  "full_scan": false,
  "full_delete": false,
  "sites": []
}

---

POST /licenses

Parameters: Array<PurchaseLicense> of all licenses

Example Request

curl -X POST https://api.privacybee.com/licenses \
     -H "Content-Type: application/json" \ 
     -d '[
           {
             "id": "complete",
             "quantity": 5
           },
           {
             "id": "trial",
             "quantity": 3
           }
         ]'

Return: 201 Created This status code indicates that the request has been successful and has led to the creation of a resource.