---
title: "List Portals"
method: GET
path: "/v2/ap-portals"
tags: ["ap-portals"]
---

# List Portals

`GET /v2/ap-portals`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/ap-portals`
- Auth: HTTP bearer

List portals

Paginated AP-portal configs for the org, each tying one customer partner to a login.
Filter by ``partner_id`` for one customer's portals or ``ap_portal_account_id`` for
one login's.

## Query parameters

- `page` integer: Page number, 0 indexed.
- `limit` integer: Number of records per page.
- `partner_id` string: Restrict to the portals of one customer partner.
- `ap_portal_account_id` string: Restrict to portals tied to one login.

## Response `200`

Successful Response

- PaginatedResponseAPPortalItem
  - `data` APPortalItem[], required: The list of records.
    - `id` string, required
    - `buyer_id` string, nullable, required
    - `partner_id` string, required
    - `account_id` string, nullable, required
    - `account_key` string, nullable, required
    - `provider` 'kehe' | 'taulia' | 'coupa' | 'ariba' | 'meijer' | 'kroger' | 'walgreens' | 'albertsons' | 'target' | 'heb' | 'heb_sidm' | 'c_and_s' | 'walmart' | 'walmart_highradius' | 'cvs' | 'cvs_sap' | 'cvs_image_silo' | 'kroger_supplier_connect' | 'kroger_claimtrax' | 'kroger_verigon' | 'servicetitan' | 'sandbox' | 'generic', required: Supported AP Portal providers.
    - `name` string, nullable, required
    - `customer_name` string, nullable, required
    - `customer_identifier` string, nullable, required
    - `is_enabled` boolean, required
    - `is_invoice_submit_enabled` boolean, required
    - `status` 'active' | 'paused', required: Status of an AP portal.
  - `current_page` integer, required: The current page.
  - `total_records` integer, nullable, required: Total number of records.
  - `next_page` integer, nullable, required: The next page number, if one exists.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/3b5ab941f918?raw)