comecerodocs
Account

List accounts

GET
/accounts

Lists every Comecero account. This is for Comecero platform staff only: any other token, including your secret token, gets 403. To read your own account, call GET /accounts/me.

The list is cursor-based. Page with after_item and before_item.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
after_item?string

For cursor-based lists, return the items after the item with this id. Use next_page_after_item (or follow next_page_url) from the page you have. You cannot send it together with before_item (400). An id that does not exist is a 404.

before_item?string

For cursor-based lists, return the items before the item with this id. Use previous_page_before_item (or follow previous_page_url) from the page you have. You cannot send it together with after_item (400). An id that does not exist is a 404.

desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
date_start?string

Only items on or after this date. Send ISO 8601 (2026-11-01T00:00:00Z or 2026-11-01T00:00:00-05:00) or a shorthand: 2026 means the start of 2026, 2026-11 the start of November, 2026-11-01 the start of that day. A date with no offset is read in timezone, or in the account's time zone when you send none. It must not be after date_end (400).

date_end?string

Only items on or before this date. Same formats as date_start, but a shorthand means the end of the period: 2026-11 is the last instant of November, 2026-11-30 the last instant of that day. A date with no offset is read in timezone, or in the account's time zone when you send none.

date_type?string

Which date date_start and date_end filter on. The default is date_created. Each list names the values it supports. A value that is not one of the values below is a 400.

Default"date_created"
Value in"date_created""date_modified""date_current_period_start""date_current_period_end""date_due""date_completed""date_ended"
q?string

Finds accounts by ID, name, email or exact alias.

live?boolean

true for live accounts only, false for accounts not yet live.

closed?boolean

true for closed accounts only, false for open ones only.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse
show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

timezone?string

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

Response Body

A cursor-based list of accounts.

application/json
  1. response

A cursor-based list of accounts.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_after_item*|

The id to send as after_item for the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_before_item*|

The id to send as before_item for the previous page, or null on the first page.

current_page_url?string

The URL of this page. Only present when the request sent after_item or before_item; the first page has no current_page_url.

Formaturi
data*array<>

The accounts on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/accounts'
Example Response
{  "next_page_url": null,  "next_page_after_item": null,  "previous_page_url": null,  "previous_page_before_item": null,  "current_page_url": "https://api.comecero.com/api/v1/accounts?limit=10",  "data": [    {      "object": "account",      "url": "https://api.comecero.com/api/v1/accounts/AB1234",      "account_id": "AB1234",      "alias": "example-shop",      "date_created": "2026-03-01T14:36:52Z",      "date_modified": "2026-10-01T09:20:11Z",      "company_name": "Example Software Ltd",      "dba": "Example Software",      "name": "John Doe",      "email": "john@example.com",      "website": "https://www.example.com",      "phone": "+1 555 0100",      "tax_number": null,      "registration_number": null,      "logo_url": "https://www.example.com/logo.png",      "address_1": "100 Main Street",      "address_2": null,      "city": "Springfield",      "state_prov": "IL",      "postal_code": "62701",      "country": "US",      "support_email": "support@example.com",      "support_website": "https://www.example.com/support",      "live": true,      "closed": false,      "date_closed": null,      "account_meta": "https://api.comecero.com/api/v1/accounts/AB1234/account_meta"    }  ]}

Overview

Previous Page

Sign up for an account POST

Creates a new Comecero account with its first user, who becomes the account owner. This is how someone signs up, so it needs no token. The response has a live trusted `token` for the owner, so they are signed in at once. The new account is not live: it can take test payments right away, and Comecero sets `live` once the account is approved. Default settings, a test gateway and a shipping method for the account's country are created with it.