API Docs
Users & Roles
API ReferenceUsersList

List Users

Returns all users in the calling merchant or organisation, depending on the API key's scope.

GET /user/user/list

Request Example

curl 'https://api.v2.paychtec.com/user/user/list' \  -H "api-key: snd_YOUR_API_KEY"

Response

[
  {
    "user_id": "user_abc123",
    "email": "alice@acme.com",
    "name": "Alice Doe",
    "role_id": "merchant_admin",
    "role_name": "Merchant Admin",
    "status": "active",
    "last_modified_at": "2024-01-22T14:00:00Z"
  },
  {
    "user_id": "user_xyz789",
    "email": "bob@acme.com",
    "role_id": "merchant_viewer",
    "role_name": "Merchant Viewer",
    "status": "invitation_sent",
    "last_modified_at": "2024-01-22T13:00:00Z"
  }
]

Status values

StatusMeaning
activeThe user has accepted the invitation and can sign in.
invitation_sentThe invite email is out but the user has not signed up yet.
invitation_expiredThe original invite link expired. Use Resend invite.
inactiveAccess revoked.