Skip to main content
GET
/
api
/
v1
/
merchants
List merchants
curl --request GET \
  --url https://app.sure.am/api/v1/merchants \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.sure.am/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Response

200 - application/json

merchants listed

​
id
string<uuid>
required
​
name
string
required
​
type
enum<string>
required

Whether the merchant was created by the user or a provider

Available options:
FamilyMerchant,
ProviderMerchant
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required