{ "info": { "_postman_id": "ba92b22a-2940-4783-ac82-252a3cce9d2b", "name": "NexHealth Adjustment Types Onboardings API", "description": "v3.0.0 and v20240412 are two names for the same API version; the Nex-Api-Version header accepts either value. Welcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.\n\nContact Support:\n Name: NexHealth\n Email: info@nexhealth.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:20:01.000Z", "updatedAt": "2026-07-28T02:20:01.000Z", "lastUpdatedBy": "35240", "uid": "35240-ba92b22a-2940-4783-ac82-252a3cce9d2b" }, "item": [ { "name": "onboardings", "item": [ { "name": "{hashid}", "item": [ { "name": "View onboarding", "id": "60cb3597-b630-4b1b-8ae7-db28f3b24e43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "id": "045cceb8-bbee-4793-b7b5-aceb0e2776ec", "key": "hashid", "value": "", "description": "(Required) The ID of the onboarding, as returned in the id field by the list and create endpoints." } ] }, "description": "Returns a single onboarding by its ID. Responds with 404 if the ID does not exist or was created by another organization." }, "response": [ { "id": "79224650-9765-41bc-8bf5-dc9f10d0cf03", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"subdomain\": \"\",\n \"url\": \"\",\n \"url_expires_at\": \"\",\n \"status\": \"in_progress\",\n \"booking_params\": {},\n \"availability_ready_at\": \"\"\n },\n \"count\": \"\"\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-79224650-9765-41bc-8bf5-dc9f10d0cf03" }, { "id": "b7c17032-e98a-421f-bf80-472fa69cd538", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-b7c17032-e98a-421f-bf80-472fa69cd538" }, { "id": "898d5d5f-74fc-40bc-be73-389f6980a148", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-898d5d5f-74fc-40bc-be73-389f6980a148" }, { "id": "4eaea5ff-f546-47c9-98b9-3f41a54f3593", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-4eaea5ff-f546-47c9-98b9-3f41a54f3593" }, { "id": "5a81c03d-9038-42dd-866c-e08db5f573ee", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-5a81c03d-9038-42dd-866c-e08db5f573ee" }, { "id": "d5bed4f3-4339-4d2a-8a85-84f00af1846e", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings/:hashid", "host": [ "{{baseUrl}}" ], "path": [ "onboardings", ":hashid" ], "variable": [ { "key": "hashid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-d5bed4f3-4339-4d2a-8a85-84f00af1846e" } ], "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-60cb3597-b630-4b1b-8ae7-db28f3b24e43" } ], "id": "aa5f0c08-8ca1-4c5e-947b-4749559df732", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-aa5f0c08-8ca1-4c5e-947b-4749559df732" }, { "name": "View onboardings", "id": "f6138f9b-3451-4253-8010-1b9f2359fd56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] }, "description": "Returns the onboardings created by your organization. Each record represents a practice setup flow: either a full onboarding of a new institution or an installation added to an existing institution. Each setup flow appears once: installations that were created as part of an onboarding are represented by their parent onboarding and are not listed separately, although their IDs (e.g. from webhook events) can still be fetched individually via GET /onboardings/:id. Optionally filter by subdomain or status." }, "response": [ { "id": "4fd16f0b-dbe0-45f9-bd1a-a9318fbe31ff", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"subdomain\": \"\",\n \"url\": \"\",\n \"url_expires_at\": \"\",\n \"status\": \"complete\",\n \"booking_params\": {},\n \"availability_ready_at\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"subdomain\": \"\",\n \"url\": \"\",\n \"url_expires_at\": \"\",\n \"status\": \"in_progress\",\n \"booking_params\": {},\n \"availability_ready_at\": \"\"\n }\n ],\n \"page_info\": {}\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-4fd16f0b-dbe0-45f9-bd1a-a9318fbe31ff" }, { "id": "8b76a91b-14aa-415f-b03a-cbb272e4d21a", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-8b76a91b-14aa-415f-b03a-cbb272e4d21a" }, { "id": "39d9fb3f-6f27-4b9d-a70f-8ae42f3cb182", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-39d9fb3f-6f27-4b9d-a70f-8ae42f3cb182" }, { "id": "586a75be-7f8f-4dcd-9dbf-c60b56cc3810", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-586a75be-7f8f-4dcd-9dbf-c60b56cc3810" }, { "id": "e34b1212-6169-419f-8c55-ee2ac1c4e067", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/onboardings?subdomain=&status=in_progress&start_cursor=&end_cursor=&per_page=5&sort=-created_at", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ], "query": [ { "description": "Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.", "key": "subdomain", "value": "" }, { "description": "Filter by status", "key": "status", "value": "in_progress" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * created_at\n * -created_at\n * status\n * -status\n * subdomain\n * -subdomain\n", "key": "sort", "value": "-created_at" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-e34b1212-6169-419f-8c55-ee2ac1c4e067" } ], "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-f6138f9b-3451-4253-8010-1b9f2359fd56" }, { "name": "Create onboarding", "id": "54f34b10-5528-401a-8154-f5116b9034c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] }, "description": "Creates an onboarding link to set up NexHealth at a practice. Include institution_name to onboard a new institution, or subdomain to add locations to an existing institution. Send the returned url to practice staff; it expires 3 months after creation. Only production applications can create onboardings." }, "response": [ { "id": "5f5a7b17-9ddf-4ccd-9540-74f40f5f260d", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"subdomain\": \"\",\n \"url\": \"\",\n \"url_expires_at\": \"\",\n \"status\": \"in_progress\",\n \"booking_params\": {},\n \"availability_ready_at\": \"\"\n },\n \"count\": \"\"\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-5f5a7b17-9ddf-4ccd-9540-74f40f5f260d" }, { "id": "1a821644-bed1-4863-b037-4ed2965db1d1", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-1a821644-bed1-4863-b037-4ed2965db1d1" }, { "id": "782289d7-9159-4e3f-a346-83e0ba4aeebf", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-782289d7-9159-4e3f-a346-83e0ba4aeebf" }, { "id": "b79bdd13-2bd3-41c8-b6ef-aa307463a0f0", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-b79bdd13-2bd3-41c8-b6ef-aa307463a0f0" }, { "id": "614217e1-a009-487c-8d17-0ba2b4c8ff1e", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-614217e1-a009-487c-8d17-0ba2b4c8ff1e" }, { "id": "7a67859b-c49b-4791-bd07-a44334482d49", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"onboarding\": {\n \"institution_name\": \"\",\n \"institution_zip_code\": \"\",\n \"institution_website\": \"\",\n \"institution_email\": \"\",\n \"subdomain\": \"\",\n \"emr_name\": \"eaglesoft\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/onboardings", "host": [ "{{baseUrl}}" ], "path": [ "onboardings" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-7a67859b-c49b-4791-bd07-a44334482d49" } ], "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-54f34b10-5528-401a-8154-f5116b9034c0" } ], "id": "aab642e8-df00-46b0-925e-7f21da5b9100", "createdAt": "2026-07-28T02:20:02.000Z", "updatedAt": "2026-07-28T02:20:02.000Z", "uid": "35240-aab642e8-df00-46b0-925e-7f21da5b9100" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://nexhealth.info" } ] }