Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
merchant-users
Error
A valid request URL is required to generate request examples
{
  "data": {
    "count": 123,
    "pages": 123,
    "users": [
      {
        "additions": {},
        "address": {
          "city": "<string>",
          "country": "<string>",
          "country_code": "<string>",
          "street": "<string>",
          "zip_code": "<string>"
        },
        "address_restrictions": [
          {
            "address_id": "<string>",
            "formatted_address": "<string>",
            "organisation_id": "<string>",
            "organisation_name": "<string>",
            "organisation_number": "<string>"
          }
        ],
        "app_id": "<string>",
        "attributes": [
          {
            "created_at": "<string>",
            "description": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "name": "<string>",
            "template_key": "<string>",
            "template_name": "<string>",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ],
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>",
            "values": {}
          }
        ],
        "comment": "<string>",
        "communication_preferences": {
          "allow_email": true,
          "allow_postal": true,
          "allow_sms": true
        },
        "created_at": "<string>",
        "email": "<string>",
        "email_verification_sent_at": "<string>",
        "email_verified": true,
        "id": "<string>",
        "is_super_admin": true,
        "language": "<string>",
        "market": "<string>",
        "name": "<string>",
        "organisations": [
          {
            "id": "<string>",
            "level": "<string>",
            "name": "<string>",
            "organisation_number": "<string>",
            "role": "<string>"
          }
        ],
        "phone_number": "<string>",
        "role": "<string>",
        "status": "<string>",
        "store_group": "<string>",
        "surname": "<string>",
        "tags": [
          {
            "attributes": [
              {
                "created_at": "<string>",
                "description": "<string>",
                "filterable": true,
                "id": "<string>",
                "key": "<string>",
                "name": "<string>",
                "template_key": "<string>",
                "template_name": "<string>",
                "translatable": true,
                "translations": {
                  "description": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "values": {}
              }
            ],
            "created_at": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "markets": [
              {
                "active": true,
                "country_codes": [
                  "<string>"
                ],
                "created_at": "<string>",
                "currency_code": "<string>",
                "id": "<string>",
                "locale": "<string>",
                "name": "<string>",
                "slug": "<string>",
                "updated_at": "<string>"
              }
            ],
            "name": "<string>",
            "schedules": [
              {
                "execute_at": "<string>",
                "finished_at": "<string>",
                "id": "<string>",
                "item_id": "<string>",
                "item_type": "<string>",
                "to_amount_cents_with_tax": 123,
                "to_on_sale": true,
                "to_sale_amount_cents_with_tax": 123,
                "to_status": "<string>"
              }
            ],
            "status": "<string>",
            "translations": {
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>"
          }
        ],
        "updated_at": "<string>"
      }
    ]
  },
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Query Parameters

page
integer

Page number (default: 1)

per-page
integer

Items per page (default: 20, max: 100)

sort-key
string

Sort field (email, market, language_code, store_group, first_name, last_name, created_at, role, status)

sort-order
string

Sort direction (asc, desc, default: desc)

Search term

market
string

Filter by market

language
string

Filter by language

store_group
string

Filter by store group

email
string

Filter by email

name
string

Filter by name

surname
string

Filter by surname

status
string

Filter by status (active, pending, inactive)

email_verified
boolean

Filter by email verification status

created_at_before
string

Filter by creation date before (YYYY-MM-DD format, e.g., 2024-05-11)

created_at_after
string

Filter by creation date after (YYYY-MM-DD format, e.g., 2024-05-11)

has_organisation
boolean

Filter by if merchant user is attached to an organisation

Response

List of merchant users

data
object
success
boolean
total
integer
total_pages
integer