# API reference

> Every StrideHQ API endpoint, by resource, generated from the OpenAPI spec.

Every endpoint in the StrideHQ API, grouped by resource. Each page shows the endpoint's parameters, an example request in Shell, Node and Python, and an example response.

## Organisation

- [Get your organisation](https://developers.stridehq.ai/api-documentation/api-reference/organisation/get-organisation.md): GET /organisation

## Creators

- [List creators](https://developers.stridehq.ai/api-documentation/api-reference/creators/list-creators.md): GET /creators
- [Create a creator](https://developers.stridehq.ai/api-documentation/api-reference/creators/create-creator.md): POST /creators
- [Search creators](https://developers.stridehq.ai/api-documentation/api-reference/creators/search-creators.md): GET /creators/search
- [Get a creator](https://developers.stridehq.ai/api-documentation/api-reference/creators/get-creator.md): GET /creators/{id}
- [Update a creator](https://developers.stridehq.ai/api-documentation/api-reference/creators/update-creator.md): PATCH /creators/{id}

## Invoices

- [List invoices](https://developers.stridehq.ai/api-documentation/api-reference/invoices/list-invoices.md): GET /invoices
- [Submit an invoice](https://developers.stridehq.ai/api-documentation/api-reference/invoices/submit-invoice.md): POST /invoices
- [Get an invoice](https://developers.stridehq.ai/api-documentation/api-reference/invoices/get-invoice.md): GET /invoices/{id}
- [Update an invoice](https://developers.stridehq.ai/api-documentation/api-reference/invoices/update-invoice.md): PATCH /invoices/{id}
- [Get the invoice file](https://developers.stridehq.ai/api-documentation/api-reference/invoices/get-invoice-file.md): GET /invoices/{id}/file

## Purchase orders

- [List purchase orders](https://developers.stridehq.ai/api-documentation/api-reference/purchase-orders/list-purchase-orders.md): GET /purchase_orders
- [Get a purchase order](https://developers.stridehq.ai/api-documentation/api-reference/purchase-orders/get-purchase-order.md): GET /purchase_orders/{id}

## Payment runs

- [List payment runs](https://developers.stridehq.ai/api-documentation/api-reference/payment-runs/list-payment-runs.md): GET /payment_runs
- [Prepare a payment run](https://developers.stridehq.ai/api-documentation/api-reference/payment-runs/prepare-payment-run.md): POST /payment_runs
- [Get a payment run](https://developers.stridehq.ai/api-documentation/api-reference/payment-runs/get-payment-run.md): GET /payment_runs/{id}
- [Withdraw a payment run](https://developers.stridehq.ai/api-documentation/api-reference/payment-runs/withdraw-payment-run.md): POST /payment_runs/{id}/withdraw
- [Get remittance advice](https://developers.stridehq.ai/api-documentation/api-reference/payment-runs/get-remittance-advice.md): GET /payment_runs/{id}/remittance_advice

## Payments

- [List payments](https://developers.stridehq.ai/api-documentation/api-reference/payments/list-payments.md): GET /payments
- [Get a payment](https://developers.stridehq.ai/api-documentation/api-reference/payments/get-payment.md): GET /payments/{id}

## Webhooks

- [List webhook endpoints](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/list-webhook-endpoints.md): GET /webhook_endpoints
- [Create a webhook endpoint](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/create-webhook-endpoint.md): POST /webhook_endpoints
- [Get a webhook endpoint](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/get-webhook-endpoint.md): GET /webhook_endpoints/{id}
- [Update a webhook endpoint](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/update-webhook-endpoint.md): PATCH /webhook_endpoints/{id}
- [Delete a webhook endpoint](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/delete-webhook-endpoint.md): DELETE /webhook_endpoints/{id}
- [Send a test event](https://developers.stridehq.ai/api-documentation/api-reference/webhooks/test-webhook-endpoint.md): POST /webhook_endpoints/{id}/test

## Events

- [List events](https://developers.stridehq.ai/api-documentation/api-reference/events/list-events.md): GET /events
- [Get an event](https://developers.stridehq.ai/api-documentation/api-reference/events/get-event.md): GET /events/{id}
- [Resend an event](https://developers.stridehq.ai/api-documentation/api-reference/events/resend-event.md): POST /events/{id}/resend

## Reference data

- [List currencies](https://developers.stridehq.ai/api-documentation/api-reference/reference-data/list-currencies.md): GET /reference/currencies
- [List countries](https://developers.stridehq.ai/api-documentation/api-reference/reference-data/list-countries.md): GET /reference/countries

## Sandbox test helpers

- [Approve a run](https://developers.stridehq.ai/api-documentation/api-reference/sandbox-test-helpers/test-approve-run.md): POST /test_helpers/payment_runs/{id}/approve
- [Fund a run](https://developers.stridehq.ai/api-documentation/api-reference/sandbox-test-helpers/test-fund-run.md): POST /test_helpers/payment_runs/{id}/fund
- [Complete a run](https://developers.stridehq.ai/api-documentation/api-reference/sandbox-test-helpers/test-complete-run.md): POST /test_helpers/payment_runs/{id}/complete
- [Fail a run](https://developers.stridehq.ai/api-documentation/api-reference/sandbox-test-helpers/test-fail-run.md): POST /test_helpers/payment_runs/{id}/fail
- [Fail a payment](https://developers.stridehq.ai/api-documentation/api-reference/sandbox-test-helpers/test-fail-payment.md): POST /test_helpers/payments/{id}/fail