{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9202e0b2-4bcd-8fd0-0ba7-6c4e76075835","name":"Particulate - Whitelabel API","description":"> Current state: **in progress** (2021.04)3.15  \nParticulate's API v4 is a completely rewritten solution to support standards like HATEOAS to offer you a well designed usage experience. \n  \n\nThis API is under active development. However most endpoints described here are stablehand can be used. If you are actively using it, send us a mail to [support@particulate.de](https://mailto:support@particulate.de) and we will inform you about any changes on existing endpoints.\n\n## Endpoints\n\nAll endpoints are only accessible via **https**.\n\n> Note on the following examples: all variables wrapped in curly brakets (like this: `{{username}}`) need to be replaced. \n  \n\n### Structure\n\nEvery successful list response follows a base structure for you to work with:\n\n``` json\n{\n    \"count\": 5,\n    \"current_page\": 1,\n    \"results\": [\n        ...\n    ],\n    \"links\": {\n        \"previous\": null,\n        \"next\": null\n    }\n}\n\n ```\n\n- `count` represents the total number of items.\n- `current_page` represents the current page, which is basically an offset of the current sorting (`offset = (current_page - 1) \\* page_size`)\n- `results` is an array of all retrieved items in the current data set.\n- `links` is a dictionary which contains pagination links if available or `null`.\n    \n\nIf not provided as an argument (e.g. `?page_size=50`), the default page size will **100**.\n\n## Security\n\nSince this API is intended for our whitelable customers, most endpoints require you to provide an access token.\n\nTo Login you need to send an Authentication Header at every request.\n\n``` json\n{\n\"Authorization\": \"Bearer {{ api-token }}\"\n}\n\n ```\n\nAuthorized users can [request their API token](#fd0a9f40-388f-a990-8776-c02fb70611c1).\n\nCurrently the only public endpoints are project(s) and organization(s).\n\n## Rate Limits\n\nCurrently we do not enforce any rate limits. This might change without notice for public facing endpoints. Whitelabel customers will be informed if we see unusual high requests\n\n## Response Codes\n\nWe use [standard HTTP response codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) with their respective meaning","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2904721","collectionId":"9202e0b2-4bcd-8fd0-0ba7-6c4e76075835","publishedId":"77cdjvz","public":true,"publicUrl":"https://api-doc.particulate.me","privateUrl":"https://go.postman.co/documentation/2904721-9202e0b2-4bcd-8fd0-0ba7-6c4e76075835","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-04-16T16:39:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sandbox - API v4 - With Examples.template","id":"e84a459f-91c7-6976-010a-a4bc2068f271","owner":"2904721","values":[{"key":"base_url","value":"https://sandbox.demo.particulate.de","enabled":true},{"key":"username","value":"testuser","enabled":true},{"key":"user-api-token","value":"e9df61aa45c06e729bdc2da45ac1ee5d33489f05","enabled":true},{"key":"projectcategory-slug","value":"gesellschaft","enabled":true},{"key":"project-slug","value":"neuanschaffungen-fuer-unsere-angebote-der-offenen-arbeit-mit-kin","enabled":true},{"key":"album-slug","value":"kinder-zu-tisch-project-photos","enabled":true},{"key":"photo-slug","value":"empty-45","enabled":true},{"key":"organization-slug","value":"ich-will-da-rauf-ev","enabled":true},{"key":"company-slug","value":"particulate-solutions-gmbh","enabled":true},{"key":"company-api-token","value":"e9df61aa45c06e729bdc2da45ac1ee5d33489f05","enabled":true},{"key":"campaign-slug","value":"testcampaign","enabled":true},{"key":"admin-username","value":"admin","enabled":true},{"key":"admin-password","value":"password12!","enabled":true},{"key":"admin-api-token","value":"6d81d6e8de35344ea4dc196fe31b710fef3ca446","enabled":true},{"key":"user-reference","value":"user-reference-1","enabled":true},{"key":"grant-amount","value":"100","enabled":true},{"key":"grant-reference","value":"grant-reference-1","enabled":true},{"key":"donation-amount","value":"100","enabled":true}],"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/cd0ca796b956d27a8d5edda98c1942fdf5d6ec15a99cd3db1b7fce49c34a36fd","favicon":"https://particulate.me/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":"Sandbox - API v4 - With Examples.template","value":"2904721-e84a459f-91c7-6976-010a-a4bc2068f271"}],"canonicalUrl":"https://api-doc.particulate.me/view/metadata/77cdjvz"}