v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Get Users

Get selected merchant user

get/v1/users

Query parameters

limitinteger

Number of records to be listed per page.

pageinteger

A number that represents the current page number.

Response

200

Example response

{
  "data": [
    {
      "object": "User",
      "id": "56Zv1pp6pAV1pA8V",
      "real_id": 39926,
      "name": "Payarc PPM TEST",
      "email": "0823405121@payarc.com",
      "created_at": 1723476064,
      "updated_at": 1723476064,
      "readable_created_at": "2 months ago",
      "readable_updated_at": "2 months ago",
      "response_content": true,
      "username": "0823405121@payarc.com",
      "role": {
        "id": 2,
        "name": "merchant-admin",
        "guard_name": "web",
        "display_name": "Merchant Administrator Role (web) (web)",
        "description": "Merchant Administrator",
        "created_at": "2019-06-17T14:17:37.000000Z",
        "updated_at": "2024-01-31T18:21:16.000000Z",
        "level": 998,
        "role_type": "merchant",
        "allow_sensitive_data": 1,
        "name_export": "merchant-admin",
        "display_name_export": "Merchant Administrator Role (web) (web)",
        "created_at_export": "2019-06-17 14:17:37",
        "role_id_export": "RMRmLEajQaKbzQjm",
        "description_export": "Merchant Administrator",
        "pivot": {
          "model_id": 39926,
          "role_id": 2,
          "model_type": "App\\Containers\\AppSection\\User\\Models\\User"
        }
      }
    }
  ],
  "meta": {
    "include": [
      "roles"
    ],
    "pagination": {
      "total": 74,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 8,
      "links": {
        "next": "https://api.payarc.io/v1/users?page=2"
      }
    }
  }
}