---
updatedAt: 2026-06-18T06:12:47.000Z
agentTools:
  projectIndex: https://developer.hellozai.com/llms.txt
---

# List Users

Retrieve an ordered and paginated list of existing **Users**.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Assembly API",
    "description": "Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.",
    "version": "2.4",
    "contact": {
      "email": "support@assemblypayments.com",
      "url": "http://docs.assemblypayments.com/"
    }
  },
  "servers": [
    {
      "url": "https://test.api.promisepay.com",
      "description": "Pre-live environment"
    },
    {
      "url": "https://secure.api.promisepay.com",
      "description": "Production environment"
    },
    {
      "url": "https://au-0000.sandbox.auth.assemblypay.com",
      "description": "Pre-Live (Sandbox) Auth issuing server and API"
    },
    {
      "url": "https://au-0000.auth.assemblypay.com",
      "description": "Production Auth issuing server and API"
    },
    {
      "description": "SwaggerHub API Auto Mocking",
      "url": "https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.1"
    }
  ],
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "ruby",
    "php",
    "javascript",
    "csharp",
    "go"
  ],
  "paths": {
    "/users": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "List Users",
        "description": "Retrieve an ordered and paginated list of existing **Users**.",
        "operationId": "listUsers",
        "parameters": [
          {
            "$ref": "#/components/parameters/limitParam"
          },
          {
            "$ref": "#/components/parameters/offsetParam"
          },
          {
            "name": "search",
            "in": "query",
            "description": "A text value to be used for searching users",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": ""
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/users"
                },
                "examples": {
                  "response": {
                    "value": {
                      "users": [
                        {
                          "id": "seller-71460518",
                          "full_name": "Assembly seller71460518",
                          "first_name": "Assembly",
                          "last_name": "seller71460518",
                          "created_at": "2020-05-06T07:26:59.479Z",
                          "updated_at": "2020-05-06T07:26:59.479Z",
                          "email": "neol_seller71460518@assemblypayments.com",
                          "mobile": "+1588750018",
                          "phone": null,
                          "location": "N/A",
                          "links": {
                            "self": "/users/seller-71460518",
                            "items": "/users/seller-71460518/items",
                            "card_accounts": "/users/seller-71460518/card_accounts",
                            "paypal_accounts": "/users/seller-71460518/paypal_accounts",
                            "bank_accounts": "/users/seller-71460518/bank_accounts",
                            "wallet_accounts": "/users/seller-71460518/wallet_accounts"
                          }
                        },
                        {
                          "id": "buyer-71439598",
                          "full_name": "Buyer",
                          "first_name": "Buyer",
                          "last_name": "",
                          "created_at": "2020-05-06T01:38:19.116Z",
                          "updated_at": "2020-05-06T02:03:25.941Z",
                          "email": "assemblybuyer71439598@assemblypayments.com",
                          "mobile": null,
                          "phone": null,
                          "location": "N/A",
                          "links": {
                            "self": "/users/buyer-71439598",
                            "items": "/users/buyer-71439598/items",
                            "card_accounts": "/users/buyer-71439598/card_accounts",
                            "paypal_accounts": "/users/buyer-71439598/paypal_accounts",
                            "bank_accounts": "/users/buyer-71439598/bank_accounts",
                            "wallet_accounts": "/users/buyer-71439598/wallet_accounts"
                          }
                        }
                      ],
                      "meta": {
                        "limit": 2,
                        "offset": 0,
                        "total": 16
                      },
                      "links": {
                        "self": "/users"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "offsetParam": {
        "name": "offset",
        "in": "query",
        "description": "Number of records to offset. Required for pagination.",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        }
      },
      "limitParam": {
        "name": "limit",
        "in": "query",
        "description": "Number of records to retrieve. Up to 200.",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 200,
          "default": 10
        }
      }
    },
    "schemas": {
      "users": {
        "type": "object",
        "properties": {
          "users": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/user"
            }
          }
        }
      },
      "user": {
        "type": "object",
        "properties": {
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "full_name": {
            "type": "string",
            "example": "Samuel Seller"
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "samuel.seller@assemblypayments.com"
          },
          "mobile": {
            "type": "string",
            "example": 61491570156
          },
          "phone": {
            "type": "string"
          },
          "logo_url": {
            "type": "string"
          },
          "color_1": {
            "type": "string"
          },
          "color_2": {
            "type": "string"
          },
          "first_name": {
            "type": "string",
            "example": "Samuel"
          },
          "last_name": {
            "type": "string",
            "example": "Seller"
          },
          "id": {
            "type": "string",
            "example": "Seller_1234"
          },
          "custom_descriptor": {
            "type": "string"
          },
          "location": {
            "type": "string",
            "example": "AUS"
          },
          "verification_status": {
            "type": "string",
            "example": "pending"
          },
          "held_state": {
            "type": "boolean",
            "example": false
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "customer"
            }
          },
          "dob": {
            "type": "string",
            "example": "encrypted"
          },
          "government_number": {
            "type": "string",
            "example": "encrypted"
          },
          "drivers_license": {
            "type": "string"
          },
          "flags": {
            "type": "object"
          },
          "related": {
            "type": "object",
            "properties": {
              "addresses": {
                "type": "string",
                "example": "fe602dcf-4175-4f88-b5be-3beb04092dcd"
              }
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string"
              },
              "items": {
                "type": "string"
              },
              "card_accounts": {
                "type": "string"
              },
              "paypal_accounts": {
                "type": "string"
              },
              "payid_accounts": {
                "type": "string"
              },
              "bpay_accounts": {
                "type": "string"
              },
              "bank_accounts": {
                "type": "string"
              },
              "wallet_accounts": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "oAuth2ClientCredentials": {
        "type": "oauth2",
        "description": "Please refer to Authentication section within https://developer.assemblypayments.com/reference#authentication",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://au-0000.sandbox.auth.assemblypay.com/tokens",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oAuth2ClientCredentials": []
    }
  ],
  "x-proxy-enabled": true,
  "x-samples-enabled": true
}
```