{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7e139907-bce8-46f6-bf5a-1ec98634ef7c","name":"Buddee API Documentation","description":"---\n\n## General\n\n- **Reading data**: Use `GET` requests.\n    \n- **Creating data**: Use `POST` requests.\n    \n- **Editing data**: Use `PUT` requests.\n    \n- **Deleting data**: Use `DELETE` requests.\n    \n\nAll API requests are made to the domain:  \n`https://api.buddee.nl/RESOURCE_NAME`\n\nFor example, to retrieve employees, make a `GET` request to:  \n`https://api.buddee.nl/employees`\n\nTo retrieve a single object, append its ID to the endpoint URL:  \n`/employees/1234`\n\nYou can also provide query filters to refine your results. Below are some examples of query filters:\n\n| **Filter** | **Description** |\n| --- | --- |\n| `employees?include=active_or_future_employment.active_or_future_salary/` | Also returns the active employment with the active employment terms (including contract hours and other details). |\n| `/employees?active=1` | All active employees that are not archived. |\n| `/employees?sort=full_name` | Sort results alphabetically by employees' full names. |\n| `/employees?page=2` | Retrieves page 2 of the results. |\n\nThe `include` filter in the above example is a comma-separated list of related objects that you want to retrieve in the JSON results.\n\n---\n\n## Authentication\n\nWe use **JWT tokens** (an access token and a refresh token) to authenticate requests. To obtain the JWT tokens, send a **Basic Auth** `POST` request to the resource: `/auth/token`.\n\n### Background Information on Basic Auth Requests:\n\nBasic authentication is a simple authentication method built into the HTTP protocol. The client sends HTTP requests with an `Authorization` header that contains the word **Basic** followed by a space and a base64-encoded string `username:password`. For example, to authorize as `demo` with password `p@55w0rd`, the client would send:\n\n```\nAuthorization: Basic ZGVtbzpwQDU1dzByZA==\n\n ```\n\nIn our case, you use the user's email address and password in the Basic Auth request. As a result, you will receive a JSON response containing the `access_token` and `refresh_token`. The `access_token` is used to authenticate requests, and the `refresh_token` is used to refresh the `access_token` (by sending the refresh token back to `/auth/token`). Alternatively, you can simply obtain a new `access_token` using the Basic Auth method without needing to use the `refresh_token`.\n\n### Authenticating Requests with the Access Token:\n\nFor each request, send the following header to authenticate with the `access_token`:\n\n```\nAuthorization: Bearer <access_token>\n\n ```\n\n### Verifying if an Access Token is Still Valid:\n\nTo check if the `access_token` is still valid, look at the `exp` claim in the JWT token data. You can extract this by splitting the JWT token by periods (`.`), and then decoding the first part (base64 decode). This will give you an array containing the `exp` claim, which is a UTC timestamp indicating the token's expiration time.\n\n---\n\n### Query Filters\n\nThe Buddee API supports dynamic query filters, enabling flexible and expressive filtering on models. Instead of using fixed operators, you can leverage the following dynamic operators to refine your queries:\n\n|  | **Operator** | **Explanation** |\n| --- | --- | --- |\n| `eq:` | `=` | Checks if the value of the column equals the provided value after `eq:`. |\n| `ne:` | `!=` or `NULL` | Checks if the value of the column is not equal to the provided value after `ne:` or is `NULL`. |\n| `lt:` | `<` | Checks if the value of the column is less than the provided value after `lt:`. |\n| `lte:` | `<=` | Checks if the value of the column is less than or equal to the provided value after `lte:`. |\n| `gt:` | `>` | Checks if the value of the column is greater than the provided value after `gt:`. |\n| `gte:` | `>=` | Checks if the value of the column is greater than or equal to the provided value after `gte:`. |\n| `in:` | `IN` | Checks if the value of the column exists in the list of values provided after `in:`. |\n| `not_in:` | `NOT IN` | Checks if the value of the column does not exist in the list of values provided after `not_in:`. |\n| `between:` | `BETWEEN` | Checks if the value of the column is within the two values provided after `between:` (comma-separated). |\n| `contains:` | `LIKE %...%` | Checks if the value of the column contains the substring provided after `contains:`. |\n| `:null` | `IS NULL` | Checks if the value of the column is `NULL`. |\n| `:not_null` | `IS NOT NULL` | Checks if the value of the column is not `NULL`. |\n| Default | `=` | Default case: Checks if the value of the column equals the provided value. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38946493","team":6694346,"collectionId":"7e139907-bce8-46f6-bf5a-1ec98634ef7c","publishedId":"2sAXxTdBF2","public":true,"publicUrl":"https://developers.buddee.nl","privateUrl":"https://go.postman.co/documentation/38946493-7e139907-bce8-46f6-bf5a-1ec98634ef7c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2196F3"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/94ccb871-3d8e-4b40-a527-ca6e47a35890/bG9nby13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2196F3"}},{"name":"light","logo":"https://content.pstmn.io/708f37bb-6986-4ac7-9a2c-05839f1c4b03/bG9nby1jb2xvci5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2196F3"}}]}},"version":"8.10.1","publishDate":"2025-01-17T13:09:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/708f37bb-6986-4ac7-9a2c-05839f1c4b03/bG9nby1jb2xvci5wbmc=","logoDark":"https://content.pstmn.io/94ccb871-3d8e-4b40-a527-ca6e47a35890/bG9nby13aGl0ZS5wbmc="}},"statusCode":200},"environments":[],"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/27c434474bdfbe38495cff9dfd468ada15a026a7bb5dc0310f00551fe8d0cee2","favicon":"https://buddee.nl/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"}],"canonicalUrl":"https://developers.buddee.nl/view/metadata/2sAXxTdBF2"}