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

# Clients

{% hint style="warning" %}
This API is only available with OAuth tokens, and requires access from the Request Finance team. Reach out to us via the Intercom widget to discuss your use case.
{% endhint %}

{% hint style="warning" %}
Contrary to invoices, there is no test environment for clients: data is shared between staging and production. Make sure to create a separate Request Finance account to test your integration before deploying it to production.
{% endhint %}

## Retrieving clients

You can list all clients with:

<mark style="color:blue;">`GET`</mark> `https://api.request.finance/clients?type=customer`

#### Query Parameters

| Name   | Type    | Description                                                                                                                           |
| ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| take   | Integer | Only available with `&format=paginated`. How many items should be returned per page. Default: `25`. Maximum: `100`.                   |
| skip   | Integer | Only available with `&format=paginated`. Use this filter to paginate the results (= skip to a certain page number). Default: `0`.     |
| search | String  | Only available with `&format=paginated`. Filter by email or business name.                                                            |
| format | String  | You can set the query parameter `&format=paginated` to enable search and pagination. It will also return the total number of results. |

Get the details of one client with:

<mark style="color:blue;">`GET`</mark> `https://api.request.finance/clients/[clientId]`


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.request.finance/clients.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.