{"info":{"_postman_id":"95f68172-7227-44f2-b18f-e601c1038174","name":"Onboard REST API","description":"

Welcome

Welcome to the Onboard REST API Documentation site. The API is available on a limited basis to our early access customers, and is subject to change. You can use the API to integrate with your product, software, or services. You can also use it to easily integrate with no-code platforms and Zapier.

Connecting to the API

To connect to our API, you must have an Onboard account. Find out more by visiting https://onboard.io/.

Once you have an account, go to https://app.onboard.io/settings/company to generate and retrieve an API key. The API key allows server-side calls to the Onboard API with full account access. It is important to keep this key secure. Do not use this for client-side or mobile app integrations without a backend, or expose it in any way in your application.

Authentication

Onboard REST API uses header authentication. Include the following header in your requests Authorization: Token YOUR_API_KEY replacing YOUR_API_KEY with the API key from your account.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome","slug":"welcome"},{"content":"Connecting to the API","slug":"connecting-to-the-api"},{"content":"Authentication","slug":"authentication"}],"owner":"12252678","collectionId":"95f68172-7227-44f2-b18f-e601c1038174","publishedId":"2sAYkHoxvi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-23T21:37:51.000Z"},"item":[{"name":"account","item":[{"name":"Get Account","id":"91aaba02-a821-4ded-a08c-66ba6ddaf4c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/account/","description":"

Returns details about your Onboard account.

\n","urlObject":{"path":["account",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"d1d3149c-4644-4457-bfe0-78860c145531","name":"Details about your Onboard account","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/account/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"company_name\": \"\",\n \"uuid\": \"\",\n \"domain\": \"\",\n \"slug\": \"\",\n \"avatar\": \"\",\n \"settings\": {\n \"background_color\": \"\",\n \"button_color\": \"\"\n },\n \"logos\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"image\": \"\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\"\n },\n \"default_api_key\": \"\"\n}"}],"_postman_id":"91aaba02-a821-4ded-a08c-66ba6ddaf4c3"},{"name":"Update Account","id":"aae7c982-cb7e-4524-b10e-0486817a9581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"company_name\": \"\",\n \"uuid\": \"\",\n \"domain\": \"\",\n \"slug\": \"\",\n \"avatar\": \"\",\n \"settings\": {\n \"background_color\": \"\",\n \"button_color\": \"\"\n },\n \"logos\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"image\": \"\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\"\n },\n \"default_api_key\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/account/","description":"

Update details about your Onboard account.

\n","urlObject":{"path":["account",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"5d01edaf-5193-4759-a9a9-d0f2f89f3a3e","name":"Updated details about your Onboard account","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"company_name\": \"\",\n \"uuid\": \"\",\n \"domain\": \"\",\n \"slug\": \"\",\n \"avatar\": \"\",\n \"settings\": {\n \"background_color\": \"\",\n \"button_color\": \"\"\n },\n \"logos\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"image\": \"\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\"\n },\n \"default_api_key\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/account/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"company_name\": \"\",\n \"uuid\": \"\",\n \"domain\": \"\",\n \"slug\": \"\",\n \"avatar\": \"\",\n \"settings\": {\n \"background_color\": \"\",\n \"button_color\": \"\"\n },\n \"logos\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"image\": \"\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\"\n },\n \"default_api_key\": \"\"\n}"}],"_postman_id":"aae7c982-cb7e-4524-b10e-0486817a9581"}],"id":"1a0717f3-c70c-4bd1-91de-9033cb705688","_postman_id":"1a0717f3-c70c-4bd1-91de-9033cb705688","description":""},{"name":"profile","item":[{"name":"Get User Profile","id":"113ffba6-1849-44d8-a4b3-757f4a12167d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/profile/","description":"

Returns details about the authenticated user's profile.

\n","urlObject":{"path":["profile",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"1db65f7c-f4ab-4104-87b6-b8a301d765af","name":"Details about a user's profile","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/profile/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"calendly_url\": \"\",\n \"linkedin_url\": \"\",\n \"twitter_url\": \"\",\n \"website_url\": \"\",\n \"bio\": \"\",\n \"job_title\": \"\",\n \"date_joined\": \"\"\n}"}],"_postman_id":"113ffba6-1849-44d8-a4b3-757f4a12167d"}],"id":"e429ce20-4c1a-4740-a314-bb4e3ec8fae6","_postman_id":"e429ce20-4c1a-4740-a314-bb4e3ec8fae6","description":""},{"name":"companies","item":[{"name":"{id}","item":[{"name":"Get Onboardee Company","id":"f450d9ac-b6d9-480c-babb-f7296c2413a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/companies/:id/","description":"

Returns details of an onboardee company.

\n","urlObject":{"path":["companies",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"7ff07ccc-61b8-45a1-9d03-32229d27ccaa","description":{"content":"

(Required) Company ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"06b1e08d-3112-4f43-ad42-c44b7ee96d46","name":"Details of onboardee company","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/companies/:id/","host":["https://rest.onboard.io"],"path":["companies",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}"}],"_postman_id":"f450d9ac-b6d9-480c-babb-f7296c2413a8"},{"name":"Update Onboardee Company","id":"c3041035-c68f-4584-a1f5-4b25072104c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/companies/:id/","description":"

Update a new onboardee company

\n","urlObject":{"path":["companies",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"9d4650fe-ff0d-463b-9446-06ed84f9033e","description":{"content":"

(Required) Company ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"78cb3a76-98e8-4bfb-b021-71b7a8705f5c","name":"Successfully updated company","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://rest.onboard.io/companies/:id/","host":["https://rest.onboard.io"],"path":["companies",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4ff7abb7-160b-4be8-85eb-c1182f96048a","name":"Invalid request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://rest.onboard.io/companies/:id/","host":["https://rest.onboard.io"],"path":["companies",":id",""],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"c3041035-c68f-4584-a1f5-4b25072104c6"}],"id":"1bb05282-9adb-4a58-882f-de8ad8d299b4","_postman_id":"1bb05282-9adb-4a58-882f-de8ad8d299b4","description":""},{"name":"List Onboardee Companies","id":"fc9d8817-f242-43d4-b800-88c1785b44db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/companies/","description":"

Returns list of onboardee companies.

\n","urlObject":{"path":["companies",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"0b946740-d3c3-4e05-a189-d796fa8947ef","name":"List of onboardee companies","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/companies/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}"}],"_postman_id":"fc9d8817-f242-43d4-b800-88c1785b44db"},{"name":"Create Onboardee Company","id":"a95d1fea-de39-436a-8dba-4f9af8629f8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/companies/","description":"

Create a new onboardee company

\n","urlObject":{"path":["companies",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"917071c7-8776-44f8-90c7-6247d632d72d","name":"Successfully created a new company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/companies/"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"348ac253-2cca-4c31-ab2b-409df024c4b2","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"external_id\": \"\",\n \"avatar\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/companies/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"a95d1fea-de39-436a-8dba-4f9af8629f8a"}],"id":"7b1a8df1-02bd-49f4-9c46-f398995f72e9","_postman_id":"7b1a8df1-02bd-49f4-9c46-f398995f72e9","description":""},{"name":"members","item":[{"name":"{id}","item":[{"name":"Get Team Member","id":"5f060f30-176e-4eee-8439-b52da95abe34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/members/:id/","description":"

Returns details of a team member from your Onboard account.

\n","urlObject":{"path":["members",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"d9066eba-0dd7-42a7-8d16-da800258fe6e","description":{"content":"

(Required) Team member ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"16018d1b-f76a-40ac-9b2d-af72d0ca8a67","name":"Details of a team member","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/members/:id/","host":["https://rest.onboard.io"],"path":["members",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}"}],"_postman_id":"5f060f30-176e-4eee-8439-b52da95abe34"},{"name":"Update Team Member","id":"33d7d780-2d4c-44e7-b371-3e670f37c66b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/members/:id/","description":"

Update details of a team member from your Onboard account.

\n","urlObject":{"path":["members",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"a50e3347-ac5f-4ded-85ee-bc3b62ddc497","description":{"content":"

(Required) Team member ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9862dcb7-b207-4447-b5df-2b6f2521e4b8","name":"Successfully updated a team member","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/members/:id/","host":["https://rest.onboard.io"],"path":["members",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}"}],"_postman_id":"33d7d780-2d4c-44e7-b371-3e670f37c66b"}],"id":"f9fbd259-2ab8-4b06-a691-30b16d289e1f","_postman_id":"f9fbd259-2ab8-4b06-a691-30b16d289e1f","description":""},{"name":"List Team Members","id":"cc6ee80f-10bf-4059-9c3e-699ce2f26ad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/members/","description":"

Returns list of team members from your Onboard account.

\n","urlObject":{"path":["members",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"6c4e133c-6d91-4cee-9659-843732a3bdcb","name":"List of team members","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/members/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}"}],"_postman_id":"cc6ee80f-10bf-4059-9c3e-699ce2f26ad8"},{"name":"Create Team Member","id":"008505a4-3470-4d62-ad03-2a3b1355e6ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/members/","description":"

Create a new team member

\n","urlObject":{"path":["members",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"036c00d5-94e8-4a27-a296-c6b0e8baaa52","name":"Successfully created a new team member","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/members/"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2a04e084-c94a-4d38-b6f4-fa037ad91835","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"team_member\",\n \"role\": \"\",\n \"status\": \"expired\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/members/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"008505a4-3470-4d62-ad03-2a3b1355e6ae"}],"id":"3123d4a5-a92c-44b9-bf87-84cf9f5b1ae4","_postman_id":"3123d4a5-a92c-44b9-bf87-84cf9f5b1ae4","description":""},{"name":"variables","item":[{"name":"{id}","item":[{"name":"Get Variable","id":"3d36d2c5-392c-4f8b-b00a-124f60acdc27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/variables/:id/","description":"

Returns details of a global variable.

\n","urlObject":{"path":["variables",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"7271fc57-35f8-44f6-b438-4d6e0d24e9ba","description":{"content":"

(Required) Variable ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0f0290f1-23b3-4439-9eaa-202cbca5c078","name":"Details of a variable","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/variables/:id/","host":["https://rest.onboard.io"],"path":["variables",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"multiple_picklist\",\n \"is_required\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"3d36d2c5-392c-4f8b-b00a-124f60acdc27"}],"id":"36744f16-fa40-440b-976a-d39cfbfb0cbb","_postman_id":"36744f16-fa40-440b-976a-d39cfbfb0cbb","description":""},{"name":"List Variables","id":"7715ee07-f64d-4dd8-92b6-2d2cf99a2aaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/variables/","description":"

Returns list of global variables.

\n","urlObject":{"path":["variables",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"3142bf55-2d12-4b26-94be-e35000fb0d46","name":"List of variables","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/variables/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"multiple_picklist\",\n \"is_required\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"7715ee07-f64d-4dd8-92b6-2d2cf99a2aaf"},{"name":"Create Variable","id":"5f2b2348-6eac-42f1-bdef-a3025f709162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"multiple_picklist\",\n \"is_required\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/variables/","description":"

Create a new variable

\n","urlObject":{"path":["variables",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"b3e98574-66d2-4c29-8b7f-2a876b526a32","name":"Successfully created a new variable","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"multiple_picklist\",\n \"is_required\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/variables/"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f222293a-3eb5-451d-bd14-6b18c8e72ec3","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"multiple_picklist\",\n \"is_required\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/variables/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"5f2b2348-6eac-42f1-bdef-a3025f709162"}],"id":"5e829cee-ca13-46a6-97c6-921fe6d14fe9","_postman_id":"5e829cee-ca13-46a6-97c6-921fe6d14fe9","description":""},{"name":"tasks","item":[{"name":"{id}","item":[{"name":"Get Task","id":"02d4ebdc-f38f-49c8-a1c0-3dff7737a808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/tasks/:id/","description":"

Returns details of a global task.

\n","urlObject":{"path":["tasks",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"93ffe339-6ab2-4ce0-946d-7f1c94c37a34","description":{"content":"

(Required) Task ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8bdc42af-96fc-457b-b385-f6548463b91f","name":"Details of a task","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/tasks/:id/","host":["https://rest.onboard.io"],"path":["tasks",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"description_preview\": \"\",\n \"is_section\": \"\",\n \"is_internal\": \"\",\n \"order\": \"\",\n \"created_at\": \"\"\n}"}],"_postman_id":"02d4ebdc-f38f-49c8-a1c0-3dff7737a808"}],"id":"7e510f62-b1ad-496f-ac9f-78bad39128fb","_postman_id":"7e510f62-b1ad-496f-ac9f-78bad39128fb","description":""},{"name":"List Tasks","id":"6d8957e5-d65f-4394-890b-e05624b87628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/tasks/","description":"

Returns list of global tasks.

\n","urlObject":{"path":["tasks",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"ddf4d940-5a29-4b7c-bdac-918adac13c02","name":"Details of a task","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/tasks/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"description_preview\": \"\",\n \"is_section\": \"\",\n \"is_internal\": \"\",\n \"order\": \"\",\n \"created_at\": \"\"\n}"}],"_postman_id":"6d8957e5-d65f-4394-890b-e05624b87628"},{"name":"Create Task","id":"ba002674-2142-449f-b431-cb2b4374f809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"description_preview\": \"\",\n \"is_section\": \"\",\n \"is_internal\": \"\",\n \"order\": \"\",\n \"created_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/tasks/","description":"

Create a new task

\n","urlObject":{"path":["tasks",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"39a3a1e0-e929-4fd9-aba7-c20f45c36178","name":"Successfully created a new task","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"description_preview\": \"\",\n \"is_section\": \"\",\n \"is_internal\": \"\",\n \"order\": \"\",\n \"created_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/tasks/"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ccfd464a-366a-46f5-9249-a4a328b06454","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"description_preview\": \"\",\n \"is_section\": \"\",\n \"is_internal\": \"\",\n \"order\": \"\",\n \"created_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/tasks/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"ba002674-2142-449f-b431-cb2b4374f809"}],"id":"d778ea59-9cc7-4751-9abd-97024f1fd62e","_postman_id":"d778ea59-9cc7-4751-9abd-97024f1fd62e","description":""},{"name":"roadmaps","item":[{"name":"{id}","item":[{"name":"tasks","item":[{"name":"List Map Tasks","id":"9caa2f5a-3a40-4206-b1c0-50d9527a6f6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/roadmaps/:id/tasks/","description":"

Returns a list of tasks in a map.

\n","urlObject":{"path":["roadmaps",":id","tasks",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"46cdc753-1259-40c3-9280-525011dc9739","description":{"content":"

(Required) Map ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"229ae0d5-2bda-4eb3-baff-02cfc6a4c378","name":"List of tasks in a map","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/roadmaps/:id/tasks/","host":["https://rest.onboard.io"],"path":["roadmaps",":id","tasks",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"reference #/components/schemas/MapTasks not found in the OpenAPI spec\"\n}"}],"_postman_id":"9caa2f5a-3a40-4206-b1c0-50d9527a6f6c"},{"name":"Create Map Task","id":"aa433be7-8c61-4a05-9013-50b581e90f8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"\",\n \"expected_launch_date\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"admin\",\n \"role\": \"\",\n \"status\": \"deactivated\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n },\n \"owner_id\": \"\",\n \"status\": \"new\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/roadmaps/:id/tasks/","description":"

Create a new map task

\n","urlObject":{"path":["roadmaps",":id","tasks",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"94bbdf80-36d0-4a5a-802b-3d5e42922ccf","description":{"content":"

(Required) Map ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2733adad-ab78-40c5-9964-e0a54c60e327","name":"Successfully created a new map","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"\",\n \"expected_launch_date\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"admin\",\n \"role\": \"\",\n \"status\": \"deactivated\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n },\n \"owner_id\": \"\",\n \"status\": \"new\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://rest.onboard.io/roadmaps/:id/tasks/","host":["https://rest.onboard.io"],"path":["roadmaps",":id","tasks",""],"variable":[{"key":"id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a7a94427-7496-4da4-8c7c-8ab989b70392","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"\",\n \"expected_launch_date\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"admin\",\n \"role\": \"\",\n \"status\": \"deactivated\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n },\n \"owner_id\": \"\",\n \"status\": \"new\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://rest.onboard.io/roadmaps/:id/tasks/","host":["https://rest.onboard.io"],"path":["roadmaps",":id","tasks",""],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\"\n}"}],"_postman_id":"aa433be7-8c61-4a05-9013-50b581e90f8c"}],"id":"ca92e0b5-1c0d-4872-adc7-7fb2943088d6","_postman_id":"ca92e0b5-1c0d-4872-adc7-7fb2943088d6","description":""},{"name":"Get Map","id":"ad28a2df-a29f-421e-90f2-ba5c01ad3319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/roadmaps/:id/","description":"

Returns details of a map.

\n","urlObject":{"path":["roadmaps",":id",""],"host":["https://rest.onboard.io"],"query":[],"variable":[{"id":"cbe97c93-60af-4b09-a565-edc13cc133ea","description":{"content":"

(Required) Map ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1d8c3038-ea8e-4c7f-8357-c1bd62a38039","name":"Details of a map","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://rest.onboard.io/roadmaps/:id/","host":["https://rest.onboard.io"],"path":["roadmaps",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"\",\n \"expected_launch_date\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"admin\",\n \"role\": \"\",\n \"status\": \"deactivated\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n },\n \"owner_id\": \"\",\n \"status\": \"new\"\n}"}],"_postman_id":"ad28a2df-a29f-421e-90f2-ba5c01ad3319"}],"id":"88d40172-e894-425a-bded-e2e2786dc9e9","_postman_id":"88d40172-e894-425a-bded-e2e2786dc9e9","description":""},{"name":"List Maps","id":"4255e744-1cf5-4f63-b8dd-f7d6c9380fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/roadmaps/","description":"

Returns list of maps.

\n","urlObject":{"path":["roadmaps",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"6088a9ee-2805-43bc-8bc4-a21c790538b0","name":"Details of a map","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://rest.onboard.io/roadmaps/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"\",\n \"expected_launch_date\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"account_type\": \"admin\",\n \"role\": \"\",\n \"status\": \"deactivated\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"invited_at\": \"\"\n },\n \"owner_id\": \"\",\n \"status\": \"new\"\n}"}],"_postman_id":"4255e744-1cf5-4f63-b8dd-f7d6c9380fd2"},{"name":"Create Map","id":"4e195134-7613-441b-a4d9-ad15e1454a2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"onboardee_company_id\": \"\",\n \"owner_id\": \"\",\n \"options\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"id\": \"\",\n \"expected_launch_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/roadmaps/","description":"

Create a new map

\n","urlObject":{"path":["roadmaps",""],"host":["https://rest.onboard.io"],"query":[],"variable":[]}},"response":[{"id":"2e77fb23-cabd-44aa-a9f7-0daadd2034ba","name":"Successfully created a new map","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"onboardee_company_id\": \"\",\n \"owner_id\": \"\",\n \"options\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"id\": \"\",\n \"expected_launch_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://rest.onboard.io/roadmaps/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"uuid\": \"\",\n \"created_at\": \"\",\n \"percentage_complete\": \"\",\n \"outboard_url\": \"\",\n \"outboard_enabled\": \"