{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2ccc0081-24c8-42b6-8378-37127a75d29d","name":"Privacy Bee API (v3)","description":"> _Privacy Bee is the unequivocal global leader in privacy, powering solutions across B2C, B2B, B2B2C, and B2B2B (MTA). With direct integrations into some of largest and most innovative organizations in the world, Privacy Bee’s API can support your product expansion, forging new revenue streams, or even integrate into complex internal environments._  \n_**With full support of Privacy Bee’s rockstar dev team, let’s build something together!**_ \n  \n\n---\n\n# Getting Started\n\nPrivacy Bee offers enterprise-grade privacy controls via our secure, stateless, and RESTful API. Requests are made with predictable verbs and form-encoded request bodies, while responses are JSON-encoded with standard HTTP response codes.\n\nThe Base URL `{{api.url}}` for all requests is [<code><b>https://api.privacybee.com/v3</b></code>](https://privacybee.dev/api/overview/#) (unless your contract instructs you to use an alternative).\n\nRequests sent via HTTP will be automatically upgraded to HTTPS (SSL required). We recommend all requests include the Keep-Alive header for increased efficiency.\n\nURL Endpoints and Header Variables**: These are **case insensitive**, meaning that it doesn’t matter whether you use uppercase or lowercase letters; the server will interpret them as the same. For example, `HTTP://API.PRIVACYBEE.COM/ENDPOINT` is equivalent to `http://api.privacybee.com/endpoint`. It is also styled using **dash-notation** (also known as _kebab-case_), where words are separated by dashes, like `user-profile` or `access-token`.\n\nForm Variables**: In contrast, form variables are **case sensitive**, which means that the server distinguishes between uppercase and lowercase letters. If a variable is expected to be in lowercase, sending it in uppercase could result in an error. Additionally, these variables are always styled in **underscore notation** (also known as snake_case), where words are separated by underscores, such as `first_name` or `account_id`.\n\n## Rate Limit\n\nAPI clients have a default rate limit of **200 Requests Per Minute (RPM)**, and upon hitting the cap, requests will be denied until the next request period begins (the next minute). To help maintain visibility into your current rate limit utilization, all successful requests will  \ninclude these response headers:\n\n| **HTTP Response Header** | **Description** |\n| --- | --- |\n| X-Rate-Limit-Limit | The number of requests remaining in the rate limit period (minute). |\n| X-Rate-Limit-Reset | The UTC unix epoch timestamp when the rate limit will return to 0% utilization |\n\nUpon exceeding the limit, all requests will fail with an **`HTTP/429 Too Many Requests`** status code and a **“****`X-Rate-Limit-Retry-After`****”** header field indicating the number of seconds until the next request period begins.\n\n## Compatibility\n\nIn order to extend the lifetime of the API, all routes will always maintain the return values that exist, but we reserve the right to add additional data to any route as we deem necessary. So it is possible that the returns will change and include more data, however we will never remove data from a return to maintain compatibility now and in the future.\n\n## Error State\n\nIf any request is authenticated properly, but does not have proper URL structure, invalid or missing parameters, is accessing restricted functionality, or any other general failure occurs, the request will return an **`HTTP/400 Bad Request`** status code.\n\nIf a request cannot be processed due to an ephemeral technical failure on Privacy Bee’s end, the request will return an **`HTTP/500 Internal Server Error`** status code. Please try this request again later, or contact support if it persists.  \nAll requests, including errors, will count against your rate limit.\n\n| Error Code | Message |\n| --- | --- |\n| HTTP/400 | Bad Request: The request cannot be fulfilled due to bad syntax. |\n| HTTP/401 | Unauthorized: Access is denied due to invalid credentials. |\n| HTTP/429 | Too Many Requests: You have exceeded the rate limit for requests. Please try again later. |\n| HTTP/500 | Internal Server Error: An unexpected condition was encountered. Please contact support. |\n\nPagination\n\nAny request that returns a list of items, such as listing employees or listing exposures, includes support for pagination variables.\n\n#### Parameters:\n\n| Variable | Data Type | Default | Required | Description |\n| --- | --- | --- | --- | --- |\n| **`per_page`** | `integer` | 50 | No | Limits the row count per page |\n| **`page`** | `integer` | 1 | No | Returns results from that page number (uses limit variable) |\n\n**Return:** If the result set supports pagination, these variables will be included in the meta response object:\n\n```\n{\n    \"data\": [... ],\n    \"meta\": {\n       \"total\" => 575,\n       \"per_page\" => 1,\n       \"current_page\" => 100,\n       \"from\": 1,\n       \"to\": 100,\n       \"last_page\": 5\n    },\n    \"query_id\": \"c485ee09-d394-4434-802a-4c025aa6adda\",\n    \"response_time\": 42,\n    \"api_version\": 3\n}\n\n ```\n\nNote: API documentation might not illustrate pagination across all examples, but if a result set array is returned, pagination is supported.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1293630","team":6695584,"collectionId":"2ccc0081-24c8-42b6-8378-37127a75d29d","publishedId":"2sAXxY5Ua2","public":true,"publicUrl":"https://docs.privacybee.dev","privateUrl":"https://go.postman.co/documentation/1293630-2ccc0081-24c8-42b6-8378-37127a75d29d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-11-21T13:59:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"PB Production","id":"cb2dce3d-950b-4d9d-8ee8-a2fb6863fd98","owner":"27377108","values":[{"key":"env.bearer-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YTZkMDc2Ni05NTM0LTQzYmQtODRkYy04YzU3NWU2ZjlmYTEiLCJqdGkiOiJmNTUyNTkyMTNjMzQ3YmUzZjRmOTA3MGMwMzA0Y2VjZTg5MjJiMTYxZDA2YTVmNWRiYWIzZGUzZWY1YjVkZmYzZGYyNjFkMDcwMjJmOWNiNSIsImlhdCI6MTcwNzY4Mzg2NC42NTc0MDYsIm5iZiI6MTcwNzY4Mzg2NC42NTc0MDgsImV4cCI6MTcwODk3OTg2NC42Mjg2MDMsInN1YiI6IjQ0Iiwic2NvcGVzIjpbXX0.Lf2YdgEpPMH_8QF5KZNBNpbMElIywufB7I4RPQqKMBgJm3r_5fRPuykobS2WxcF2oYwsykDK9348cNz_eBb0Uvu52WuyTmRHBqGcPn__gGGIfpDKv__jq-jp691G5zvs7ghM8aONJcELnXpCpsONWy3JrXaKRR2orHKlkMTN6b4iuIfyZ4EO8CpK9fdR9TRoRHKm4f-2CrY8CdYxQ2lJ7XWTN_aKs3GO-RXmxZ7ltHkIcxljUeNQ_H-J7rtloMuLbml3-UklFGLOphBsjQSmt9hv9GQN6bBwfZABTSlvtHOEqxNW6YW0RV-QSfm6E2HY7Ko7L3eZjVQn0liO3zbXXD7XQX_-7BsqDn8kPabgOUjYIoRq1IsbKXo98DWswxx9R8LT_Rrh8aePoRgt908IuIuBvWDVLHWMIuvLIgveAXHKi5gpj5WGE3PiBMKbSzTXa7jqzF4cvZHHUv1UrRX39R8LuuYcSGnUGum6poaCHAwxd4lDLU9fvOO2KoNEIlwsJDAz_cfAcsil5gwoeKRXNkFAwZD5G6JtjXnKKE9A1vf8RdXnNGI1kDmzEKaRZo2f7LXjgJAK7ybSK3nLecGI6_6OZ4cuZwtp5sB6x04MrWNt9MrKNhmthafiOHlJE_XdZYZLE7rLxrh6qEpVzgP7UbnLaKAtqTE2wYn15NS9ACM","enabled":true,"type":"default"},{"key":"api.url","value":"https://api.privacybee.com/v3","enabled":true,"type":"any"},{"key":"env.api.url","value":"https://api.privacybee.com/v3","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/39125a085c3a55e6d9dafc5cd0d04d220c8b055b6e68f693db945d153415f4a3","favicon":"https://privacybee.dev/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PB Production","value":"27377108-cb2dce3d-950b-4d9d-8ee8-a2fb6863fd98"}],"canonicalUrl":"https://docs.privacybee.dev/view/metadata/2sAXxY5Ua2"}