# Partners

```{eval-rst}
.. autoclass:: ab.api.endpoints.partners.PartnersEndpoint
   :members:
   :undoc-members:
```

## Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the
Python and CLI call signatures, and the request/response model field tables.
This is the page `help(api.partners.<method>)` links to via its `Docs:` footer.
These pages are generated by `scripts/generate_endpoint_docs.py` and kept
current by a CI freshness gate.

```{toctree}
:maxdepth: 1
:glob:

partners/*
```


## Methods

### list

`GET /partner` — List all partners.

**Returns:** `list[`{class}`~ab.api.models.partners.Partner`]`

```python
partners = api.partners.list()
```

### get

`GET /partner/{id}` — Get a partner by ID.

**Returns:** {class}`~ab.api.models.partners.Partner`

### search

`POST /partner/search` — Search partners.

**Returns:** `list[`{class}`~ab.api.models.partners.Partner`]`

```python
results = api.partners.search(searchText="Navis")
```