{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2bbe630e-22e9-4495-ab8a-5fed32ffac37","name":"Woub","description":"The Woub.nl REST API provides a convenient way to interact with the platform using a set of HTTP methods for resource management.\n\n# Overview\n\n- GET: Retrieve resources\n    \n- POST: Create new resources\n    \n- PUT: Update existing resources\n    \n- DELETE: Remove resources\n    \n\n# Authentication\n\nThere are two methods to authenticate API requests:\n\n### **1\\. JWT Authentication (JSON Web Token)**\n\nJWT tokens are used to authenticate users. A valid token must be included in the Authorization header for all requests, with the format:\n\n`Authorization: Bearer {your_jwt_token}`\n\nThe following endpoints do not require JWT authentication:  \n/register  \n/login  \n/forgotpassword  \n/resetpassword/{token}  \n/confirm-email/{token}  \n/registerinvite/{token}\n\nToken Expiry:  \nIf a token is about to expire, a response header Woub-Token-Expire will be included. This indicates when the token will expire, and the client can request a new token using the /login method.  \nIf the token is expired but can still be renewed, the server will include an updated Authorization header in the response. Use the new token from this header for future requests.\n\n### **2\\. API Key Authentication**\n\nAPI keys offer another method of authenticating API requests. Clients can request an API key by contacting support. Once provided, this key must be included in the Authorization header with the format:\n\n`Authorization: ApiKey {your_api_key}`\n\nThis method is especially useful for clients who do not require JWT token-based authentication.\n\n# OK Codes\n\nAt this time the following HTTP responses are used:\n\n- 200 OK\n    \n- 204 No content\n    \n- 201 Created\n    \n\n# Error Codes\n\nAt this time the following HTTP responses are used:\n\n- 400 Bad Request\n    \n- 401 Unauthorized\n    \n- 403 Forbidden\n    \n- 404 Not found\n    \n- 409 Conflict\n    \n- 429 Too Many Requests\n    \n- 500 Server error\n    \n\n# Rate limit\n\nFor authentication requests is there a limit of 6 requests in 10 minutes.\n\nFor API key is there a limit of 100 requests per minute per API key.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6117561","collectionId":"2bbe630e-22e9-4495-ab8a-5fed32ffac37","publishedId":"2s9YXpTxNz","public":true,"publicUrl":"https://developer.woub.chat","privateUrl":"https://go.postman.co/documentation/6117561-2bbe630e-22e9-4495-ab8a-5fed32ffac37","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C36"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/2c6d678c-69d8-480f-859d-3f7f5998137e/d291Yl9sb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C36"}},{"name":"light","logo":"https://content.pstmn.io/2c6d678c-69d8-480f-859d-3f7f5998137e/d291Yl9sb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C36"}}]}},"version":"8.10.1","publishDate":"2024-09-04T22:34:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/2c6d678c-69d8-480f-859d-3f7f5998137e/d291Yl9sb2dvLnBuZw==","logoDark":"https://content.pstmn.io/2c6d678c-69d8-480f-859d-3f7f5998137e/d291Yl9sb2dvLnBuZw=="}},"statusCode":200},"environments":[{"name":"Woub Production API","id":"90207342-e426-4db9-862b-0c6a6d5be0bc","owner":"6117561","values":[{"key":"{{ROOT}}","value":"https://api.woub.chat","enabled":true,"type":"default"},{"key":"{{prefix}}","value":"api/v1","enabled":true,"type":"default"},{"key":"{{project_id}}","value":"1","enabled":true,"type":"default"},{"key":"{{chat_id}}","value":"2","enabled":true,"type":"default"},{"key":"{{checklist_id}}","value":"3","enabled":true,"type":"default"},{"key":"{{checklist_item_id}}","value":"4","enabled":true,"type":"default"},{"key":"{{invite_token}}","value":"38ZBpN3nY2Bq8Y7bCowunf029h3f092j3gofinwogn34XDydpFwE06MwHbcmMWOvkZYEpJt9AvyUxpZi8qJT1LbG","enabled":true,"type":"default"},{"key":"Search param","value":"{{test search}}","enabled":true},{"key":"TOKEN","value":"","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://woub.chat/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":"Woub Production API","value":"6117561-90207342-e426-4db9-862b-0c6a6d5be0bc"}],"canonicalUrl":"https://developer.woub.chat/view/metadata/2s9YXpTxNz"}