Mercury: List all customers
Mercury customers.listCustomers: arguments, response, policy and SDK examples.
← Customers operations · Get started
Operation mercury.listcustomers
Provider route: GET /ar/customers. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["customers"]["listCustomers"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.customers.listCustomers(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.customers.list_customers(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.start_after | string | Optional | The ID of the customer to start the page after (exclusive). When provided, results will begin with the customer immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before. Format: uuid |
query.end_before | string | Optional | The ID of the customer to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after. Format: uuid |
query.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’ Default: asc One of: asc, desc |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List all customers — response body |
Referenced models: List all customers — response body
Schemas
Section titled “Schemas”List all customers — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response data for Accounts Receivable customers API endpoint |
customers | array | Required within parent | The list of customers for this page |
customers[] | Model | Each item | Expand Get a customer — response body |
page | object | Required within parent | Pagination cursors for navigating to next/previous pages |
page.nextPage | string | Optional | The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first. Format: uuid |
page.previousPage | string | Optional | The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first. Format: uuid |
Referenced models: Get a customer — response body
Get a customer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response data for Accounts Receivable customer API endpoints |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region |
address (anyOf 1) (allOf 2) | JSON | All variants apply | Address of customer. |
address (anyOf 2) | null | Alternative | |
deletedAt | JSON | Optional | |
deletedAt (anyOf 1) | JSON | Alternative | |
deletedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
deletedAt (anyOf 1) (allOf 2) | JSON | All variants apply | The time the customer was deleted, if it was deleted. |
deletedAt (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | Email of customer. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first. Format: uuid |
id (allOf 2) | JSON | All variants apply | ArCustomerId |
name | string | Required within parent | Name of customer. Maximum length: 5000 Minimum length: 1 |
Referenced models: Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customer address information for Accounts Receivable API |
address1 | string | Required within parent | Primary street address line. Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Secondary street address line (optional). Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
country (allOf 2) | JSON | All variants apply | Two-letter country code (ISO 3166-1 alpha-2). |
postalCode | string | Required within parent | Postal or ZIP code Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply | |
region (allOf 2) | JSON | All variants apply | State, province, or region. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.listcustomers. Catalog operation: mercury:listCustomers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.