Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_afterstringOptionalThe 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_beforestringOptionalThe 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.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List all customers — response body

Referenced models: List all customers — response body

List all customers — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response data for Accounts Receivable customers API endpoint
customersarrayRequired within parentThe list of customers for this page
customers[]ModelEach itemExpand Get a customer — response body
pageobjectRequired within parentPagination cursors for navigating to next/previous pages
page.nextPagestringOptionalThe 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.previousPagestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootResponse data for Accounts Receivable customer API endpoints
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
address (anyOf 1) (allOf 2)JSONAll variants applyAddress of customer.
address (anyOf 2)nullAlternative
deletedAtJSONOptional
deletedAt (anyOf 1)JSONAlternative
deletedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
deletedAt (anyOf 1) (allOf 2)JSONAll variants applyThe time the customer was deleted, if it was deleted.
deletedAt (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyEmail of customer.
idJSONRequired within parent
id (allOf 1)stringAll variants applyThe 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)JSONAll variants applyArCustomerId
namestringRequired within parentName 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
FieldTypePresenceDescription and constraints
$objectRootCustomer address information for Accounts Receivable API
address1stringRequired within parentPrimary street address line.
Maximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeSecondary street address line (optional).
Maximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
Maximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
country (allOf 2)JSONAll variants applyTwo-letter country code (ISO 3166-1 alpha-2).
postalCodestringRequired within parentPostal or ZIP code
Maximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
region (allOf 2)JSONAll variants applyState, province, or region.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.