List merchants

get

https://api.cardda.com/v1/merchants

Returns a paginated list of merchants (normalized payees) linked to the
company's transactions. Access requires an admin or one of the
transactions_rules_view / transactions_rules_manage permissions. The result
is scoped to the merchants referenced by the company's ledger transactions.

Merchants are used to group and label card spend (e.g. resolving "AMZN MKTP US"
to "Amazon") and to power transaction rules. All operators in
Filters are supported on the columns
below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

company_id

uuid

Company-context fallback used when the company-id header is absent. A
non-admin caller must supply company context (header or this query param)
to satisfy the permission-based index? gate; admins may omit both.

_start

integer

≥ 0

If all the cards where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the cards where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

string

Filter by merchant id. Use id={"$in":[...]} for batch lookups.

name

string

Normalized merchant name. Combine with $regex for text search.

Headers

company-id

uuid

required

UUID of the company that owns the card.

Responses

401

Unauthorized — missing or invalid bearer token, or the caller lacks the
transactions_rules_view / transactions_rules_manage permission and is
not an admin (Pundit authorization failure). A non-admin caller must
supply company context via the company-id header (or a company_id
query param): index? is permission-based (permission? needs a company
membership) and the non-admin scope is company-scoped, so without it the
request lands here. Returned with an empty body.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of merchants. Headers include X-Total-Count and Content-Range for offset pagination — see Pagination.