# Saturation API Reference

> Generated from OpenAPI 3.1.0 at build time. Use this with `/openapi.yaml` for schemas and exact enum values.

Base URL: `https://next-api.saturation.io/v1`

Authentication is `Authorization: Bearer <token>` unless an operation says otherwise. The token is bound to one workspace, so paths start at `/v1/projects`, `/v1/contacts`, or another resource. Do not prefix paths with a workspace id.

## Endpoints

### Budget

- [GET /v1/projects/{projectId}/budget](/api-reference/budget_get.md): Get a budget.
- [GET /v1/projects/{projectId}/budget/lines](/api-reference/budget_listLines.md): List budget lines.
- [POST /v1/projects/{projectId}/budget/lines](/api-reference/budget_createLine.md): Create a budget line.
- [GET /v1/projects/{projectId}/budget/lines/{lineId}](/api-reference/budget_getLine.md): Get a budget line.
- [PATCH /v1/projects/{projectId}/budget/lines/{lineId}](/api-reference/budget_updateLine.md): Update a budget line.
- [DELETE /v1/projects/{projectId}/budget/lines/{lineId}](/api-reference/budget_deleteLine.md): Delete a budget line.
- [PUT /v1/projects/{projectId}/budget/lines/{lineId}/phase-data/{phaseId}](/api-reference/budget_updateLinePhaseData.md): Update phase data for a budget line.
- [POST /v1/projects/{projectId}/budget/lines/bulk](/api-reference/budget_createLinesBulk.md): Create budget lines.
- [POST /v1/projects/{projectId}/budget/lines/phase-data/bulk](/api-reference/budget_updateLinePhaseDataBulk.md): Update phase data for budget lines.
- [GET /v1/projects/{projectId}/budget/phases](/api-reference/budget_listPhases.md): List budget phases.
- [POST /v1/projects/{projectId}/budget/phases](/api-reference/budget_createPhase.md): Create a budget phase.
- [GET /v1/projects/{projectId}/budget/phases/{phaseId}](/api-reference/budget_getPhase.md): Get a budget phase.
- [PATCH /v1/projects/{projectId}/budget/phases/{phaseId}](/api-reference/budget_updatePhase.md): Update a budget phase.
- [DELETE /v1/projects/{projectId}/budget/phases/{phaseId}](/api-reference/budget_deletePhase.md): Delete a budget phase.
- [GET /v1/projects/{projectId}/budget/totals](/api-reference/budget_getTotals.md): Get budget totals.

### Comments

- [GET /v1/projects/{projectId}/comments](/api-reference/comments_list.md): List comments.
- [POST /v1/projects/{projectId}/comments](/api-reference/comments_create.md): Create a comment.
- [PATCH /v1/projects/{projectId}/comments/{commentId}](/api-reference/comments_update.md): Update a comment.
- [DELETE /v1/projects/{projectId}/comments/{commentId}](/api-reference/comments_delete.md): Delete a comment.

### Contacts

- [GET /v1/contacts](/api-reference/contacts_list.md): List contacts.
- [POST /v1/contacts](/api-reference/contacts_create.md): Create a contact.
- [GET /v1/contacts/{contactId}](/api-reference/contacts_get.md): Get a contact.
- [PATCH /v1/contacts/{contactId}](/api-reference/contacts_update.md): Update a contact.
- [DELETE /v1/contacts/{contactId}](/api-reference/contacts_delete.md): Delete a contact.

### Documents

- [GET /v1/documents](/api-reference/documents_list.md): List documents.
- [POST /v1/documents](/api-reference/documents_upload.md): Upload a document.
- [GET /v1/documents/{documentId}](/api-reference/documents_get.md): Get a document.
- [PATCH /v1/documents/{documentId}](/api-reference/documents_update.md): Update a document.
- [DELETE /v1/documents/{documentId}](/api-reference/documents_delete.md): Delete a document.
- [GET /v1/documents/{documentId}/content](/api-reference/documents_getContent.md): Download a document.
- [GET /v1/documents/{documentId}/extraction](/api-reference/documents_getExtraction.md): Get extracted document data.
- [PUT /v1/documents/{documentId}/links/{kind}](/api-reference/documents_link.md): Link a document.
- [DELETE /v1/documents/{documentId}/links/{kind}](/api-reference/documents_unlink.md): Remove a document link.

### Library

- [GET /v1/library/currencies](/api-reference/library_listCurrencies.md): List currencies.
- [POST /v1/library/currencies](/api-reference/library_createCurrency.md): Create a currency.
- [GET /v1/library/currencies/{currencyId}](/api-reference/library_getCurrency.md): Get a currency.
- [PATCH /v1/library/currencies/{currencyId}](/api-reference/library_updateCurrency.md): Update a currency.
- [DELETE /v1/library/currencies/{currencyId}](/api-reference/library_deleteCurrency.md): Delete a currency.
- [GET /v1/library/fringe-groups](/api-reference/library_listFringeGroups.md): List fringe groups.
- [POST /v1/library/fringe-groups](/api-reference/library_createFringeGroup.md): Create a fringe group.
- [GET /v1/library/fringe-groups/{fringeGroupId}](/api-reference/library_getFringeGroup.md): Get a fringe group.
- [PATCH /v1/library/fringe-groups/{fringeGroupId}](/api-reference/library_updateFringeGroup.md): Update a fringe group.
- [DELETE /v1/library/fringe-groups/{fringeGroupId}](/api-reference/library_deleteFringeGroup.md): Delete a fringe group.
- [GET /v1/library/fringes](/api-reference/library_listFringes.md): List fringes.
- [POST /v1/library/fringes](/api-reference/library_createFringe.md): Create a fringe.
- [GET /v1/library/fringes/{fringeId}](/api-reference/library_getFringe.md): Get a fringe.
- [PATCH /v1/library/fringes/{fringeId}](/api-reference/library_updateFringe.md): Update a fringe.
- [DELETE /v1/library/fringes/{fringeId}](/api-reference/library_deleteFringe.md): Delete a fringe.
- [GET /v1/library/globals](/api-reference/library_listGlobals.md): List globals.
- [POST /v1/library/globals](/api-reference/library_createGlobal.md): Create a global.
- [GET /v1/library/globals/{globalId}](/api-reference/library_getGlobal.md): Get a global.
- [PATCH /v1/library/globals/{globalId}](/api-reference/library_updateGlobal.md): Update a global.
- [DELETE /v1/library/globals/{globalId}](/api-reference/library_deleteGlobal.md): Delete a global.
- [GET /v1/library/incentive-packs](/api-reference/library_listIncentivePacks.md): List incentive packs.
- [GET /v1/library/incentive-packs/{packId}](/api-reference/library_getIncentivePack.md): Get an incentive pack.
- [POST /v1/library/incentive-packs/{packId}/enablement](/api-reference/library_enableIncentivePack.md): Enable an incentive pack for the workspace.
- [DELETE /v1/library/incentive-packs/{packId}/enablement](/api-reference/library_disableIncentivePack.md): Disable an incentive pack for the workspace.
- [GET /v1/library/incentive-packs/{packId}/programs](/api-reference/library_listIncentivePrograms.md): List incentive programs.
- [GET /v1/library/rate-packs](/api-reference/library_listRatePacks.md): List rate packs.
- [POST /v1/library/rate-packs](/api-reference/library_createRatePack.md): Create a rate pack.
- [GET /v1/library/rate-packs/{packId}](/api-reference/library_getRatePack.md): Get a rate pack.
- [PATCH /v1/library/rate-packs/{packId}](/api-reference/library_updateRatePack.md): Update a rate pack.
- [DELETE /v1/library/rate-packs/{packId}](/api-reference/library_deleteRatePack.md): Delete a rate pack.
- [POST /v1/library/rate-packs/{packId}/enablement](/api-reference/library_enableRatePack.md): Enable a rate pack for the workspace.
- [DELETE /v1/library/rate-packs/{packId}/enablement](/api-reference/library_disableRatePack.md): Disable a rate pack for the workspace.
- [GET /v1/library/rate-packs/{packId}/items](/api-reference/library_listRatePackItems.md): List rate pack items.
- [POST /v1/library/rate-packs/{packId}/items](/api-reference/library_createRatePackItem.md): Add a rate pack item.
- [PATCH /v1/library/rate-packs/{packId}/items/{itemId}](/api-reference/library_updateRatePackItem.md): Update a rate pack item.
- [DELETE /v1/library/rate-packs/{packId}/items/{itemId}](/api-reference/library_deleteRatePackItem.md): Delete a rate pack item.
- [GET /v1/library/tags](/api-reference/library_listTags.md): List tags.
- [POST /v1/library/tags](/api-reference/library_createTag.md): Create a workspace tag.
- [GET /v1/library/tags/{tagId}](/api-reference/library_getTag.md): Get a workspace tag.
- [PATCH /v1/library/tags/{tagId}](/api-reference/library_updateTag.md): Update a workspace tag.
- [DELETE /v1/library/tags/{tagId}](/api-reference/library_deleteTag.md): Delete a workspace tag.
- [GET /v1/library/units](/api-reference/library_listUnits.md): List units.
- [POST /v1/library/units](/api-reference/library_createUnit.md): Create a unit.
- [GET /v1/library/units/{unitId}](/api-reference/library_getUnit.md): Get a unit.
- [PATCH /v1/library/units/{unitId}](/api-reference/library_updateUnit.md): Update a unit.
- [DELETE /v1/library/units/{unitId}](/api-reference/library_deleteUnit.md): Delete a unit.
- [GET /v1/projects/{projectId}/library/currencies](/api-reference/library_listProjectCurrencies.md): List project currencies.
- [POST /v1/projects/{projectId}/library/currencies](/api-reference/library_addProjectCurrency.md): Add a currency to a project.
- [GET /v1/projects/{projectId}/library/currencies/{currencyId}](/api-reference/library_getProjectCurrency.md): Get a project currency.
- [PATCH /v1/projects/{projectId}/library/currencies/{currencyId}](/api-reference/library_updateProjectCurrency.md): Update a project currency.
- [DELETE /v1/projects/{projectId}/library/currencies/{currencyId}](/api-reference/library_deleteProjectCurrency.md): Remove a project currency.
- [GET /v1/projects/{projectId}/library/fringe-groups](/api-reference/library_listProjectFringeGroups.md): List project fringe groups.
- [POST /v1/projects/{projectId}/library/fringe-groups](/api-reference/library_addProjectFringeGroup.md): Add a fringe group to a project.
- [GET /v1/projects/{projectId}/library/fringe-groups/{fringeGroupId}](/api-reference/library_getProjectFringeGroup.md): Get a project fringe group.
- [PATCH /v1/projects/{projectId}/library/fringe-groups/{fringeGroupId}](/api-reference/library_updateProjectFringeGroup.md): Update a project fringe group.
- [DELETE /v1/projects/{projectId}/library/fringe-groups/{fringeGroupId}](/api-reference/library_deleteProjectFringeGroup.md): Remove a project fringe group.
- [GET /v1/projects/{projectId}/library/fringes](/api-reference/library_listProjectFringes.md): List project fringes.
- [POST /v1/projects/{projectId}/library/fringes](/api-reference/library_addProjectFringe.md): Add a fringe to a project.
- [GET /v1/projects/{projectId}/library/fringes/{fringeId}](/api-reference/library_getProjectFringe.md): Get a project fringe.
- [PATCH /v1/projects/{projectId}/library/fringes/{fringeId}](/api-reference/library_updateProjectFringe.md): Update a project fringe.
- [DELETE /v1/projects/{projectId}/library/fringes/{fringeId}](/api-reference/library_deleteProjectFringe.md): Remove a project fringe.
- [GET /v1/projects/{projectId}/library/globals](/api-reference/library_listProjectGlobals.md): List project globals.
- [POST /v1/projects/{projectId}/library/globals](/api-reference/library_addProjectGlobal.md): Add a global to a project.
- [GET /v1/projects/{projectId}/library/globals/{globalId}](/api-reference/library_getProjectGlobal.md): Get a project global.
- [PATCH /v1/projects/{projectId}/library/globals/{globalId}](/api-reference/library_updateProjectGlobal.md): Update a project global.
- [DELETE /v1/projects/{projectId}/library/globals/{globalId}](/api-reference/library_deleteProjectGlobal.md): Remove a project global.
- [GET /v1/projects/{projectId}/library/incentives](/api-reference/library_listProjectIncentives.md): List project incentives.
- [POST /v1/projects/{projectId}/library/incentives](/api-reference/library_addProjectIncentive.md): Add an incentive to a project.
- [GET /v1/projects/{projectId}/library/incentives/{incentiveId}](/api-reference/library_getProjectIncentive.md): Get a project incentive.
- [PATCH /v1/projects/{projectId}/library/incentives/{incentiveId}](/api-reference/library_updateProjectIncentive.md): Update a project incentive.
- [DELETE /v1/projects/{projectId}/library/incentives/{incentiveId}](/api-reference/library_deleteProjectIncentive.md): Remove a project incentive.
- [GET /v1/projects/{projectId}/library/tags](/api-reference/library_listProjectTags.md): List project tags.

### Meta

- [GET /v1/me](/api-reference/me_get.md): Get the current identity.

### Payment Requests

- [GET /v1/payment-requests](/api-reference/payment-requests_list.md): List payment requests.
- [GET /v1/payment-requests/{paymentRequestId}](/api-reference/payment-requests_get.md): Get a payment request.

### Payments

- [GET /v1/payments](/api-reference/payments_list.md): List payments.
- [GET /v1/payments/{paymentId}](/api-reference/payments_get.md): Get a payment.
- [GET /v1/payments/{paymentId}/timeline](/api-reference/payments_getTimeline.md): Get a payment timeline.

### Projects

- [GET /v1/projects](/api-reference/projects_list.md): List projects.
- [POST /v1/projects](/api-reference/projects_create.md): Create a project.
- [GET /v1/projects/{projectId}](/api-reference/projects_get.md): Get a project.
- [PATCH /v1/projects/{projectId}](/api-reference/projects_update.md): Update a project.

### Purchase Orders

- [GET /v1/purchase-orders](/api-reference/purchase-orders_list.md): List purchase orders.
- [POST /v1/purchase-orders](/api-reference/purchase-orders_create.md): Create a purchase order.
- [GET /v1/purchase-orders/{purchaseOrderId}](/api-reference/purchase-orders_get.md): Get a purchase order.
- [PATCH /v1/purchase-orders/{purchaseOrderId}](/api-reference/purchase-orders_update.md): Update a purchase order.
- [DELETE /v1/purchase-orders/{purchaseOrderId}](/api-reference/purchase-orders_delete.md): Delete a purchase order.
- [POST /v1/purchase-orders/{purchaseOrderId}/cancel-submission](/api-reference/purchase-orders_cancelSubmission.md): Cancel a pending submission.
- [GET /v1/purchase-orders/{purchaseOrderId}/items](/api-reference/purchase-orders_listItems.md): List purchase order items.
- [POST /v1/purchase-orders/{purchaseOrderId}/items](/api-reference/purchase-orders_createItem.md): Add a purchase order item.
- [PATCH /v1/purchase-orders/{purchaseOrderId}/items/{itemId}](/api-reference/purchase-orders_updateItem.md): Update a purchase order item.
- [DELETE /v1/purchase-orders/{purchaseOrderId}/items/{itemId}](/api-reference/purchase-orders_deleteItem.md): Delete a purchase order item.
- [POST /v1/purchase-orders/{purchaseOrderId}/mark-paid](/api-reference/purchase-orders_markPaid.md): Mark a purchase order as paid.
- [POST /v1/purchase-orders/{purchaseOrderId}/submit](/api-reference/purchase-orders_submit.md): Submit a purchase order for approval.
- [GET /v1/purchase-orders/{purchaseOrderId}/timeline](/api-reference/purchase-orders_getTimeline.md): Get the purchase order timeline.
- [PUT /v1/purchase-orders/{purchaseOrderId}/transactions/{transactionId}](/api-reference/purchase-orders_linkTransaction.md): Link a transaction to a purchase order.
- [DELETE /v1/purchase-orders/{purchaseOrderId}/transactions/{transactionId}](/api-reference/purchase-orders_unlinkTransaction.md): Unlink a transaction from a purchase order.
- [POST /v1/purchase-orders/{purchaseOrderId}/void](/api-reference/purchase-orders_void.md): Void a purchase order.

### Search

- [GET /v1/search](/api-reference/search_workspace.md): Search the workspace or one project.

### Spaces

- [GET /v1/spaces](/api-reference/spaces_list.md): List spaces.
- [POST /v1/spaces](/api-reference/spaces_create.md): Create a space.
- [PATCH /v1/spaces/{spaceId}](/api-reference/spaces_update.md): Update a space.
- [DELETE /v1/spaces/{spaceId}](/api-reference/spaces_delete.md): Delete a space.

### Transactions

- [GET /v1/transactions](/api-reference/transactions_list.md): List transactions.
- [POST /v1/transactions](/api-reference/transactions_create.md): Create a manual transaction.
- [GET /v1/transactions/{transactionId}](/api-reference/transactions_get.md): Get a transaction.
- [PATCH /v1/transactions/{transactionId}](/api-reference/transactions_update.md): Update a transaction.
- [DELETE /v1/transactions/{transactionId}](/api-reference/transactions_delete.md): Delete a manual transaction.
- [GET /v1/transactions/{transactionId}/items](/api-reference/transactions_listItems.md): List transaction items.
- [POST /v1/transactions/{transactionId}/items](/api-reference/transactions_createItem.md): Add a transaction item.
- [PATCH /v1/transactions/{transactionId}/items/{itemId}](/api-reference/transactions_updateItem.md): Update a transaction item.
- [DELETE /v1/transactions/{transactionId}/items/{itemId}](/api-reference/transactions_deleteItem.md): Delete a transaction item.
- [POST /v1/transactions/bulk](/api-reference/transactions_createBulk.md): Create manual transactions in bulk.
- [GET /v1/transactions/stats](/api-reference/transactions_stats.md): Get transaction totals.

### Webhook Subscriptions

- [GET /v1/webhooks](/api-reference/webhooks_list.md): List webhook subscriptions.
- [POST /v1/webhooks](/api-reference/webhooks_create.md): Create a webhook subscription.
- [GET /v1/webhooks/{webhookId}](/api-reference/webhooks_get.md): Get a webhook subscription.
- [PATCH /v1/webhooks/{webhookId}](/api-reference/webhooks_update.md): Update a webhook subscription.
- [DELETE /v1/webhooks/{webhookId}](/api-reference/webhooks_delete.md): Delete a webhook subscription.
- [GET /v1/webhooks/{webhookId}/deliveries](/api-reference/webhooks_listDeliveries.md): List recent deliveries.
- [POST /v1/webhooks/{webhookId}/test-delivery](/api-reference/webhooks_sendTestDelivery.md): Send a test delivery.