# Nimbo Developers

> Developer documentation for Nimbo integrations, API contracts, and webhooks.

- [Build with Nimbo](https://dev.nimbo-x.com/index.md): Find API contracts and integration guidance for connecting your software to Nimbo.
- [Prepare your first request](https://dev.nimbo-x.com/quickstart.md): Confirm integration access, choose your environment, and prepare a request to Nimbo.
- [Environments and testing](https://dev.nimbo-x.com/guides/environments.md): Prepare an isolated test setup and verify your integration before using production data.
- [Authentication](https://dev.nimbo-x.com/authentication.md): Use the authentication method and permissions assigned to your Nimbo integration.
- [Request conventions](https://dev.nimbo-x.com/guides/request-conventions.md): Construct API URLs, preserve request types, and handle dates, amounts, and failures.
- [Troubleshoot an integration](https://dev.nimbo-x.com/guides/troubleshooting.md): Diagnose authentication, access, connection, and delivery failures without duplicating records.
- [Create a patient](https://dev.nimbo-x.com/guides/patients.md): Choose patient identifiers, prepare a patient request, and retain the returned person ID.
- [Schedule an appointment](https://dev.nimbo-x.com/guides/appointments.md): Find availability, create an appointment, and retrieve its saved details.
- [Build a patient portal](https://dev.nimbo-x.com/guides/patient-portal.md): Verify a phone number and read records for people authorized by a patient portal session.
- [Charges and invoicing](https://dev.nimbo-x.com/guides/billing.md): Connect consultations, encounter invoices, charge lines, and CFDI delivery.
- [Receive webhook events](https://dev.nimbo-x.com/guides/webhooks.md): Register an event subscription and inspect delivery records using the webhook service.
- [Browse API endpoints](https://dev.nimbo-x.com/reference/overview.md): Find Nimbo endpoints by functionality and review the requirements for your integration.
- [POST /people](https://dev.nimbo-x.com/api-reference/patient-management/post-people.md): Creates a patient for an authorized treating account. A mobile number and phone country are required unless without_cellphone is true. Additional validation can depend on the organization country and patient configuration.
- [PUT /people/{person_id}](https://dev.nimbo-x.com/api-reference/patient-management/put-people.md)
- [DELETE /people/{person_id}](https://dev.nimbo-x.com/api-reference/patient-management/delete-people.md)
- [GET /people/{person_id}](https://dev.nimbo-x.com/api-reference/patient-management/get-people.md)
- [GET /accounts/{account_id}/people](https://dev.nimbo-x.com/api-reference/patient-management/get-accounts-people.md)
- [GET /predictions/people](https://dev.nimbo-x.com/api-reference/patient-management/get-predictionspeople.md)
- [GET /accounts/{account_id}/patient_groups](https://dev.nimbo-x.com/api-reference/patient-management/get-accounts-patient_groups.md)
- [GET /custom_fields](https://dev.nimbo-x.com/api-reference/patient-management/get-custom_fields.md)
- [POST /custom_fields](https://dev.nimbo-x.com/api-reference/patient-management/post-custom_fields.md)
- [GET /people/{people_id}/custom_form_response](https://dev.nimbo-x.com/api-reference/patient-management/get-people-custom_form_response.md)
- [POST /custom_form_responses
](https://dev.nimbo-x.com/api-reference/patient-management/post-custom_form_responses.md)
- [GET /consultation_surveys/{consultation_survey_id}/custom_form_response](https://dev.nimbo-x.com/api-reference/patient-management/get-consultation_surveys-custom_form_response.md)
- [POST /consultation_schedules](https://dev.nimbo-x.com/api-reference/schedules/post-consultation_schedules.md)
- [GET /consultation_schedules/{consultation_schedule_id}](https://dev.nimbo-x.com/api-reference/consultation-schedules/get-consultation_schedules.md)
- [PUT /consultation_schedules/{consultation_schedule_id}](https://dev.nimbo-x.com/api-reference/consultation-schedules/put-consultation_schedules.md)
- [DELETE /consultation_schedules/{consultation_schedule_id}](https://dev.nimbo-x.com/api-reference/consultation-schedules/delete-consultation_schedules.md)
- [GET /consultation_schedule_notifications](https://dev.nimbo-x.com/api-reference/consultation-schedules/get-consultation_schedule_notifications.md)
- [GET /calendar/available_hours](https://dev.nimbo-x.com/api-reference/consultation-schedules/get-calendaravailable_hours.md)
- [GET /api/v1/calendar/available_hours_organization](https://dev.nimbo-x.com/api-reference/consultation-schedules/get-apiv1calendaravailable_hours_organization.md)
- [GET /consultations](https://dev.nimbo-x.com/api-reference/consultations/get-consultations.md)
- [POST /consultations](https://dev.nimbo-x.com/api-reference/consultations/post-consultations.md)
- [GET /consultations/{consultation_id}/consultation_diagnostics](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-consultation_diagnostics.md)
- [GET /consultations/{consultation_id}/consultation_prescription_drugs](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-consultation_prescription_drugs.md)
- [POST /consultation_lab_test_results](https://dev.nimbo-x.com/api-reference/consultations/post-consultation_lab_test_results.md)
- [GET /consultations/{consultation_id}/physiotherapy_records](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-physiotherapy_records.md)
- [GET /consultations/{consultation_id}/disability_leave](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-disability_leave.md)
- [GET /consultations/{consultation_id}](https://dev.nimbo-x.com/api-reference/get-consultations.md)
- [POST /prescriptions](https://dev.nimbo-x.com/api-reference/consultations/post-prescriptions.md)
- [PUT /prescriptions](https://dev.nimbo-x.com/api-reference/consultations/put-prescriptions.md)
- [POST /consultation_prescription_drugs](https://dev.nimbo-x.com/api-reference/consultations/post-consultation_prescription_drugs.md)
- [DELETE /consultation_prescription_drugs/{consultation_prescription_drug_id}](https://dev.nimbo-x.com/api-reference/consultations/delete-consultation_prescription_drugs.md)
- [GET /consultations/{consultation_id}/consultation_lab_tests](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-consultation_lab_tests.md)
- [GET /lab_tests/{lab_test_id}](https://dev.nimbo-x.com/api-reference/consultations/get-lab_tests.md)
- [GET /consultations/{consultation_id}/consultation_procedures](https://dev.nimbo-x.com/api-reference/consultations/get-consultations-consultation_procedures.md)
- [GET /procedures/{procedure_id}](https://dev.nimbo-x.com/api-reference/consultations/get-procedures.md)
- [GET /people/{people_id}/medical_history](https://dev.nimbo-x.com/api-reference/medical-history/get-people-medical_history.md)
- [POST /medical_histories](https://dev.nimbo-x.com/api-reference/medical-history/post-medical_histories.md)
- [POST /medical_notes](https://dev.nimbo-x.com/api-reference/medical-notes/post-medical_notes.md)
- [GET /medical_notes](https://dev.nimbo-x.com/api-reference/medical-notes/get-medical_notes.md)
- [GET /people/{people_id}/vital_signs_sets](https://dev.nimbo-x.com/api-reference/vital-signs/get-people-vital_signs_sets.md)
- [POST /vital_signs_sets](https://dev.nimbo-x.com/api-reference/vital-signs/post-vital_signs_sets.md)
- [Request a patient portal OTP](https://dev.nimbo-x.com/api-reference/patient-portal-authentication/request-a-patient-portal-otp.md): Requests a one-time code for the patient phone number. Use the country code and phone fields supplied for your integration.
- [Validate a patient portal OTP](https://dev.nimbo-x.com/api-reference/patient-portal-authentication/validate-a-patient-portal-otp.md): Exchanges the one-time code and patient phone number for a patient portal token. Use this token to access the people authorized for that patient session.
- [List people attached to the current patient token](https://dev.nimbo-x.com/api-reference/patient-portal/list-people-attached-to-the-current-patient-token.md): Lists the non-deleted people authorized for the patient portal token, newest first. The response includes chat availability; a chat-service connection failure can cause the request to fail.
- [Show an authorized patient's public organization](https://dev.nimbo-x.com/api-reference/patient-portal/show-an-authorized-patients-public-organization.md)
- [Show or create an authorized patient's medical history](https://dev.nimbo-x.com/api-reference/patient-portal/show-or-create-an-authorized-patients-medical-history.md): Returns the medical history for an authorized patient. If no active history exists, this read creates a new medical history record.
- [Show merged patient-facing vital signs](https://dev.nimbo-x.com/api-reference/patient-portal/show-merged-patient-facing-vital-signs.md)
- [Show patient-facing lab test results](https://dev.nimbo-x.com/api-reference/patient-portal/show-patient-facing-lab-test-results.md)
- [List patient-shared medical history attachments](https://dev.nimbo-x.com/api-reference/patient-portal/list-patient-shared-medical-history-attachments.md)
- [List authorized patient consultations](https://dev.nimbo-x.com/api-reference/patient-portal/list-authorized-patient-consultations.md): Returns consultation-history membership independently of booking eligibility. Each summary keeps its historical physician and exposes doctor_active so consumers can omit inactive physicians from "Mis médicos" without deleting clinical history. url_portal is non-null only when that physician is activ…
- [List authorized patient prescriptions](https://dev.nimbo-x.com/api-reference/patient-portal/list-authorized-patient-prescriptions.md)
- [List authorized patient consultation schedules](https://dev.nimbo-x.com/api-reference/patient-portal/list-authorized-patient-consultation-schedules.md)
- [List authorized patient consultation requests](https://dev.nimbo-x.com/api-reference/patient-portal/list-authorized-patient-consultation-requests.md)
- [List organization portals available to an authorized patient](https://dev.nimbo-x.com/api-reference/patient-portal/list-organization-portals-available-to-an-authorized-patient.md): Lists the personal booking link, eligible organization schedules, and visible telehealth waiting rooms for the authorized patient, in that order. Availability depends on the organization subscription and each portal's scheduling and visibility settings. Organization schedules and waiting rooms are o…
- [GET /invoice_item_locations](https://dev.nimbo-x.com/api-reference/charges/get-invoice_item_locations.md)
- [GET /invoice_items/invoice_items_payment](https://dev.nimbo-x.com/api-reference/charges/get-invoice_itemsinvoice_items_payment.md)
- [POST /invoices](https://dev.nimbo-x.com/api-reference/charges/post-invoices.md)
- [POST /consultation_invoice_items](https://dev.nimbo-x.com/api-reference/charges/post-consultation_invoice_items.md)
- [GET /encounters/{encounter_id}/invoice](https://dev.nimbo-x.com/api-reference/get-encounters-invoice.md)
- [GET /invoices/{invoice_id}/consultation_invoice_items](https://dev.nimbo-x.com/api-reference/get-invoices-consultation_invoice_items.md)
- [POST /invoices/{id}/sign](https://dev.nimbo-x.com/api-reference/post-invoices-sign.md)
- [GET /invoices/{id}/download_cfdi.pdf](https://dev.nimbo-x.com/api-reference/get-invoices-download_cfdipdf.md)
- [GET /invoices/{id}/download_cfdi.xml](https://dev.nimbo-x.com/api-reference/get-invoices-download_cfdixml.md)
- [POST /invoices/{id}/email_invoice](https://dev.nimbo-x.com/api-reference/post-invoices-email_invoice.md)
- [GET /reports/consultation_invoice_items](https://dev.nimbo-x.com/api-reference/get-reportsconsultation_invoice_items.md)
- [POST /invoice_items](https://dev.nimbo-x.com/api-reference/inventory-management/post-invoice_items.md)
- [PUT /invoice_items/{invoice_item_id}](https://dev.nimbo-x.com/api-reference/inventory-management/put-invoice_items.md)
- [POST /item_transactions](https://dev.nimbo-x.com/api-reference/inventory-management/post-item_transactions.md)
- [POST /telehealth_waiting_rooms](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/post-telehealth_waiting_rooms.md)
- [GET /waiting_rooms/{waiting_room_id}/custom_forms](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/get-waiting_rooms-custom_forms.md)
- [GET /telehealth_waiting_rooms/{waiting_room_encrypted_id}/check](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/get-telehealth_waiting_rooms-check.md)
- [List waiting rooms](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/get-waiting_rooms.md): List teleconsultation waiting rooms.
- [Get a waiting room](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/get-waiting_rooms-1.md): Retrieve a teleconsultation waiting room by ID.
- [GET /waiting_rooms/waiting_room_slug](https://dev.nimbo-x.com/api-reference/teleconsultation-waiting-room/get-waiting_roomswaiting_room_slug.md)
- [POST /oauth/token](https://dev.nimbo-x.com/api-reference/authentication/post-oauthtoken.md): Exchanges approved account credentials or a refresh token for integration tokens. Use the returned expires_in value. Accounts requiring two-factor authentication can return a 403 challenge instead of access tokens.
- [GET /organizations/current](https://dev.nimbo-x.com/api-reference/account-management/get-organizationscurrent.md)
- [GET /locations](https://dev.nimbo-x.com/api-reference/account-management/get-locations.md)
- [POST /invitations](https://dev.nimbo-x.com/api-reference/account-management/post-invitations.md)
- [POST /accounts/set_password](https://dev.nimbo-x.com/api-reference/account-management/post-accountsset_password.md)
- [PUT /account_profiles/{account_id}](https://dev.nimbo-x.com/api-reference/account-management/put-account_profiles.md)
- [PUT /accounts/{account_id}](https://dev.nimbo-x.com/api-reference/account-management/put-accounts.md)
- [GET /accounts/{account_id}](https://dev.nimbo-x.com/api-reference/account-management/get-accounts.md)
- [GET /accounts/me](https://dev.nimbo-x.com/api-reference/account-management/get-accountsme.md)
- [GET /organization_members](https://dev.nimbo-x.com/api-reference/account-management/get-organization_members.md)
- [POST /oauth/token](https://dev.nimbo-x.com/api-reference/post-oauthtoken.md)
- [POST /webhooks](https://dev.nimbo-x.com/api-reference/post-webhooks.md)
- [GET /webhooks](https://dev.nimbo-x.com/api-reference/get-webhooks.md)
- [GET /events](https://dev.nimbo-x.com/api-reference/get-events.md)
- [DELETE /webhooks/{webhook_id}](https://dev.nimbo-x.com/api-reference/delete-webhooks.md)
- [Show public organization branding](https://dev.nimbo-x.com/api-reference/sites/show-public-organization-branding.md): Resolves public organization branding by encoded slug or encoded custom domain, with plain slug or host fallback. Linked accounts are ordered by account ID.
- [List countries](https://dev.nimbo-x.com/api-reference/countries/list-countries.md): Lists active countries. Inactive countries are excluded.
- [Get a country](https://dev.nimbo-x.com/api-reference/countries/get-a-country.md): Returns an active country. Inactive countries are treated as not found.
- [List states for a country](https://dev.nimbo-x.com/api-reference/countries/list-states-for-a-country.md): Lists states for an active country in ascending ID order. Inactive countries are treated as not found.
- [Get a state](https://dev.nimbo-x.com/api-reference/catalogs/get-a-state.md)
- [List counties for a state](https://dev.nimbo-x.com/api-reference/catalogs/list-counties-for-a-state.md)
- [GET /specialties/{specialty_id}](https://dev.nimbo-x.com/api-reference/account-management/get-specialties.md)
- [List specialties](https://dev.nimbo-x.com/api-reference/catalogs/list-specialties.md)
- [List currencies](https://dev.nimbo-x.com/api-reference/catalogs/list-currencies.md)
- [List languages](https://dev.nimbo-x.com/api-reference/catalogs/list-languages.md)
- [List relationships](https://dev.nimbo-x.com/api-reference/catalogs/list-relationships.md)
- [List identification types for an organizational portal](https://dev.nimbo-x.com/api-reference/catalogs/list-identification-types-for-an-organizational-portal.md)
- [List SAT CFDI uses](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-cfdi-uses.md)
- [Search SAT measurement units](https://dev.nimbo-x.com/api-reference/sat-catalogs/search-sat-measurement-units.md): Returns measurement units in ascending ID order, including timestamps in the America/Monterrey time zone.
- [Search SAT product and service keys](https://dev.nimbo-x.com/api-reference/sat-catalogs/search-sat-product-and-service-keys.md): Returns product and service keys in ascending ID order, including timestamps in the America/Monterrey time zone.
- [List SAT payment forms](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-payment-forms.md)
- [List SAT payment methods](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-payment-methods.md)
- [List SAT tax types](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-tax-types.md)
- [List SAT factor types](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-factor-types.md)
- [List SAT rates or fees](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-rates-or-fees.md)
- [List SAT tax regimes](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-tax-regimes.md)
- [List SAT periodicities](https://dev.nimbo-x.com/api-reference/sat-catalogs/list-sat-periodicities.md)

## OpenAPI Specs

- [nimbo_api](/openapi/nimbo_api.yml)
- [nimbo_erp](/openapi/nimbo_erp.yml)
- [nimbo_facturacion](/openapi/nimbo_facturacion.yml)
- [nimbo_patient_portal](/openapi/nimbo_patient_portal.yml)
- [nimbo_public](/openapi/nimbo_public.yml)
- [nimbo_webhooks](/openapi/nimbo_webhooks.yml)

## Optional

- [Nimbo help center](https://help.nimbo-x.com)