Skip to main content

List Merchant Users

GET 
/v1/acquirer/merchants/:merchant_id/users

List the dashboard users of a merchant.

Required permission: merchant_users_read.

Request​

Path Parameters

    merchant_id stringrequired

    Acquirer-assigned merchant identifier (the merchant_id field of the merchant, not its internal UUID).

Query Parameters

    sort[field] string

    Possible values: [name, email, created_at, updated_at]

    Default value: created_at

    sort[dir] string

    Possible values: [asc, desc]

    Default value: desc

Responses​

The merchant's users.

Schema

  • Array [

    • id uuidrequired

    A 36-character UUIDv7 identifier.

    active booleanrequired

    false while the user is disabled.

    merchant_id uuidrequired

    A 36-character UUIDv7 identifier.

    email emailrequired
    name stringrequired
    description stringnullable
    permissions string[]required
    two_factor_enabled boolean
    created_by_user_id uuid

    A 36-character UUIDv7 identifier.

    disabled_by_user_id uuid

    A 36-character UUIDv7 identifier.

    disabled_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    invited_by_id uuid

    A 36-character UUIDv7 identifier.

    invited_by_type stringnullable

    Possible values: [AcquirerUser, MerchantUser, StaffUser, AcquirerApiKey, null]

    invitation_sent_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    invitation_accepted_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    password_expires_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    must_reset_password_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    password_reset_at date-time

    ISO 8601 UTC timestamp with time zone designator.

    created_at date-timerequired

    ISO 8601 UTC timestamp with time zone designator.

    updated_at date-timerequired

    ISO 8601 UTC timestamp with time zone designator.

  • ]

Loading...
Last updated on