List users
Lists the users of your account in the mode of the token you call with. A test token lists test users. The list is offset-based.
Secret and trusted tokens may call this with the users read permission.
AuthorizationBearer <token>A secret, trusted or limited token. See Authentication.
limit?integerHow 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.
1 <= value <= 100100offset?integerFor offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.
0 <= value0sort_by?stringThe field to sort by. The default is user_id.
"user_id""user_id""name""email""date_created""date_modified"desc?booleanSort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.
falseq?stringFinds users whose user_id or email is exactly this value, or whose name contains it (any case).
formatted?booleanWhen 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.
falseshow?stringComma-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?stringComma-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?stringAn 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.
An offset-based list of users.
application/json- response
An offset-based list of users.
total_items*integerHow many items match, across all pages.
total_pages*integerHow many pages there are at this limit. 0 when nothing matches.
current_page*integerThe number of this page, starting at 1. 0 when nothing matches.
next_page_url*|The URL of the next page, or null on the last page.
urinext_page_offset*|The offset of the next page, or null on the last page.
previous_page_url*|The URL of the previous page, or null on the first page.
uriprevious_page_offset*|The offset of the previous page, or null on the first page.
current_page_url*stringThe URL of this page.
uridata*array<>The users on this page.
curl -X GET 'https://api.comecero.com/api/v1/users'{ "total_items": 1, "total_pages": 1, "current_page": 1, "next_page_url": null, "next_page_offset": null, "previous_page_url": null, "previous_page_offset": null, "current_page_url": "https://api.comecero.com/api/v1/users", "data": [ { "object": "user", "url": "https://api.comecero.com/api/v1/users/jane.smith.test", "user_id": "jane.smith.test", "test": true, "date_created": "2026-10-01T14:36:52Z", "date_modified": "2026-10-01T14:36:52Z", "account_id": "AB1234", "account_alias": "example-shop", "account_live": true, "name": "Jane Smith", "email": "jane@example.com", "is_account_owner": false, "language": "en", "locale": "en-US", "date_last_login": "2026-11-06T09:12:40Z", "allow_test_transactions": true, "roles": [ "support" ], "permissions": [], "effective_permissions": { "orders": { "create": false, "read": true, "update": true, "delete": false } }, "meta": null } ]}Overview
Previous Page
Create a user POST
Adds a user who can sign in to your dashboard, in the mode of the token you call with. A user made with a test token is a test user and its `user_id` gets `.test` added. Fires the `user:created` event. Secret and trusted tokens may call this with the `users` create permission.