Partners

class ab.api.endpoints.partners.PartnersEndpoint(client)[source]

Partner operations (ACPortal API).

Parameters:

client (HttpClient)

list()[source]

GET /partner

Docs: https://ab-sdk.readthedocs.io/en/latest/api/partners/list.html Query params: PartnerListParams Response model: List[Partner]

Return type:

list[Partner]

get(partner_id)[source]

GET /partner/{id}

Docs: https://ab-sdk.readthedocs.io/en/latest/api/partners/get.html Response model: Partner

Parameters:

partner_id (str)

Return type:

Partner

search(*, data)[source]

POST /partner/search.

Parameters:

data (PartnerSearchRequest | dict) – Partner search payload. Accepts a PartnerSearchRequest instance or a dict.

Return type:

list[Partner]

Request model: PartnerSearchRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/partners/search.html Request model: PartnerSearchRequest Response model: List[Partner]

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.

Methods

list

GET /partner — List all partners.

Returns: list[Partner]`

partners = api.partners.list()

get

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

Returns: Partner