> For the complete documentation index, see [llms.txt](https://docs.dutchmanbridge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dutchmanbridge.com/api-reference/readme.md).

# Overview

Every Partner API route, grouped by what it does. Each endpoint lists its parameters and body fields, with a curl request and an example response, all generated from the API's own definitions.

**Base URL**

```
https://app.dutchmanbridge.com/api/v1/partner/v1
```

**Authentication.** Send your API key in the `x-api-key` header on every request. See [Authentication](https://docs.dutchmanbridge.com/get-started/authentication).

**Responses.** Every response is `{ "success": true, "data": ... }`, with `meta.nextCursor` on paginated lists (loop until it is `null`). Errors are `{ "success": false, "statusCode", "code", "message" }`: branch on `statusCode` and `code`. The [developer platform](https://docs.dutchmanbridge.com/developer-platform/responses-and-errors) covers the envelope, retries and pagination in full.

**OpenAPI spec.** The whole reference as one OpenAPI document, to import into Postman or Insomnia or to generate a client from:

```
https://app.dutchmanbridge.com/api/docs/partner-json
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.dutchmanbridge.com/api-reference/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.