---
seo:
  description: >-
    The HTTP API an Application or an integration connector uses to work with an
    organization on Hydda One. Every request carries an access token from the
    token…
sidebar:
  label: Overview
title: Hydda One API
---
The HTTP API an Application or an integration connector uses to work with an organization on Hydda One. Every request carries an access token from the token endpoint on the identity host.

Version 1

Base URL: `https://api.hydda.one`, `https://api.dev.hydda.one`

## Operational contexts

The parts of the organization a token can act in. Start here.

- [`GET /v1/operational-contexts`](/reference/operational-contexts/list-my-operational-contexts) — List the operational contexts the token can act in.

## Booking

Sell bookable resources on your own website: list them, read their free time and request bookings an operator approves.

- [`GET /v1/booking/resources`](/reference/booking/list-externally-bookable-resources) — List the resources the Application may sell.
- [`GET /v1/booking/resources/{resourceId}`](/reference/booking/get-externally-bookable-resource) — Get one resource the Application may sell.
- [`GET /v1/booking/resources/{resourceId}/availability`](/reference/booking/read-external-availability) — Read a resource's free time.
- [`GET /v1/booking/resources/{resourceId}/add-on-products`](/reference/booking/list-external-add-on-products) — List the extras a resource sells.
- [`POST /v1/booking/company-lookups`](/reference/booking/read-external-company-status) — Look up a company by organisation number.
- [`POST /v1/booking/booking-requests/preview`](/reference/booking/preview-external-booking-request) — Price a booking before requesting it.
- [`POST /v1/booking/booking-requests`](/reference/booking/request-external-booking) — Request a booking for a guest.
- [`GET /v1/booking/booking-requests/{bookingId}`](/reference/booking/get-external-booking-request) — Get a booking request.

## Billing

Connect an ERP or invoicing service: send approved invoices and report what happened to them.

- [`GET /v1/billing/send-queue`](/reference/billing/list-send-queue) — List approved invoices ready to send.
- [`GET /v1/billing/verification-queue`](/reference/billing/list-verification-queue) — List invoice proposals awaiting verification.
- [`POST /v1/billing/invoice-proposals/{proposalId}/pass`](/reference/billing/pass-proposal) — Pass an invoice proposal.
- [`POST /v1/billing/invoice-proposals/{proposalId}/reject`](/reference/billing/reject-proposal) — Reject an invoice proposal.
- [`POST /v1/billing/invoices/{invoiceId}/report-sent`](/reference/billing/report-sent) — Report an invoice sent.
- [`POST /v1/billing/invoices/{invoiceId}/report-failed`](/reference/billing/report-invoice-failed) — Report an invoice that could not be sent.
- [`POST /v1/billing/invoices/{invoiceId}/report-payment`](/reference/billing/report-payment) — Report a payment on an invoice.
- [`POST /v1/billing/invoices/{invoiceId}/report-payment-reversed`](/reference/billing/report-payment-reversed) — Report a payment taken back.
- [`POST /v1/billing/invoices/{invoiceId}/report-write-off`](/reference/billing/report-write-off) — Report a write-off on an invoice.
- [`GET /v1/billing/withdrawal-queue`](/reference/billing/list-invoice-withdrawal-queue) — List deleted invoices you may still hold.
- [`POST /v1/billing/invoice-withdrawals/{invoiceId}/report-discarded`](/reference/billing/report-withdrawal-discarded) — Report a deleted invoice discarded.
- [`POST /v1/billing/invoices/by-external-reference/{externalReference}/report-payment`](/reference/billing/report-payment-by-external-reference) — Report a payment by your own invoice id.
- [`POST /v1/billing/invoices/by-external-reference/{externalReference}/report-payment-reversed`](/reference/billing/report-payment-reversed-by-external-reference) — Report a payment reversal by your own invoice id.

## Signing

Connect an e-signing service: send contracts out for signature and report the outcome.

- [`GET /v1/crm/signing-queue`](/reference/signing/list-signing-queue) — List contracts waiting to be sent for signature.
- [`GET /v1/crm/withdrawal-queue`](/reference/signing/list-signing-withdrawal-queue) — List signing attempts the operator wants withdrawn.
- [`POST /v1/crm/signing-attempts/{attemptId}/started`](/reference/signing/report-started) — Report that the document is out for signature.
- [`POST /v1/crm/signing-attempts/{attemptId}/signed-document-upload`](/reference/signing/request-signed-document-upload) — Get an upload address for the signed PDF.
- [`POST /v1/crm/signing-attempts/{attemptId}/signed`](/reference/signing/report-signed) — Report that every party signed.
- [`POST /v1/crm/signing-attempts/{attemptId}/declined`](/reference/signing/report-declined) — Report that a party declined to sign.
- [`POST /v1/crm/signing-attempts/{attemptId}/expired`](/reference/signing/report-expired) — Report that the document expired unsigned.
- [`POST /v1/crm/signing-attempts/{attemptId}/withdrawn`](/reference/signing/report-withdrawn) — Report that the document was cancelled.
- [`POST /v1/crm/signing-attempts/{attemptId}/failed`](/reference/signing/report-signing-failed) — Report that the document could not be created.

## Integrations

Read your own configuration as an installed integration and report when it is ready.

- [`GET /v1/integrations/configurations`](/reference/integrations/list-own-integration-configurations) — List your installation's configurations.
- [`POST /v1/integrations/connection-references/redeem`](/reference/integrations/redeem-connection-reference) — Redeem a connection reference from your setup address.
- [`POST /v1/integrations/configurations/{configurationId}/ready`](/reference/integrations/report-configuration-ready) — Report a configuration as ready.
- [`POST /v1/integrations/configurations/{configurationId}/failed`](/reference/integrations/report-configuration-failed) — Report a configuration as failed.