> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ach.netevia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All Users

> This endpoints allow to get all users

[Suggest Edits](/edit/get-all-users)

This API provides a comprehensive list of all registered businesses and individuals, including essential details. Pagination options are available to efficiently manage large datasets.

<Info>
  This route is secured with **processor** and **vendor** token authentication.
</Info>

### Endpoint

GET   **/3p/api/v2/users**

 

### Query Parameters

| Fields          | Type    | Is Required | Description                                                                                              |
| --------------- | ------- | ----------- | -------------------------------------------------------------------------------------------------------- |
| **per\_page**   | integer | No          | By default: 10 Min: 1 Max: 100                                                                           |
| **role**        | string  | No          | *Possible Value: business person*                                                                        |
| **start\_date** | string  | No          | This parameter will filter the user's records based on the creation date of the user. Date format: Y-m-d |
| **end\_date**   | string  | No          | This parameter will filter the user's records based on the creation date of the user. Date format: Y-m-d |
| **sort\_order** | string  | No          | By default: newest *Possible Value: newest oldest*                                                       |
| **page**        | integer | No          | By default: 1 Min: 1                                                                                     |

### Response

<CodeGroup>
  ```json Example theme={"system"}
  {
      "status": true,
      "message": "",
      "data": [
          {
              "uuid": "1874a4e0-ab7b-4ea3-a7ff-fde712b88cd6",
              "first_name": "Andrew",
              "last_name": "test",
              "email": null,
              "phone": null,
              "status": "APPROVED",
              "address": {
                  "street_address": "Elm Street",
                  "additional_address": "Third flore",
                  "city": "New",
                  "state": "NY",
                  "country": "USA",
                  "zip": "12345"
              },
              "created_at": "2024-01-04 16:02:08",
              "updated_at": "2024-01-04 16:02:08"
          },
          {
              "uuid": "7ddd38b2-110e-4163-a966-818a95a0163e",
              "first_name": null,
              "last_name": "test",
              "email": null,
              "phone": null,
              "status": "APPROVED",
              "address": {
                  "street_address": "Elm Street",
                  "additional_address": "Third flore",
                  "city": "New",
                  "state": "NY",
                  "country": "USA",
                  "zip": "12345"
              },
              "created_at": "2024-01-04 16:05:39",
              "updated_at": "2024-01-04 16:05:39"
          },
          ........
      ],
      "errors": null,
      "error_code": null
  }
  ```
</CodeGroup>

***

* [Table of Contents](#)

* * [Endpoint](#endpoint)
  * [Query Parameters](#query-parameters)
  * [Response](#response)