---
page_title: List all agents
product: lotuspay
platform: web
page_source: https://docs.juspay.io/lotuspay/web/core-resources/list-all-agents
openapi: https://docs.juspay.io/api/swagger?document=https%3A%2F%2Fdocs.juspay.io%2Flotuspay%2Fweb%2Fcore-resources%2Flist-all-agents
llms_txt: https://docs.juspay.io/llms.txt
product_llms_txt: https://docs.juspay.io/lotuspay/llms.txt
---

## API Version: default


# **List all agents** 



You can see a list of your agents. The agents are returned sorted by creation date, with the most recent appearing first. You can use this API method and the limit parameter to page through agents.

**ARGUMENTS** 


| Argument | Description |
|---|---|
| limit optional, default is 100	 | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 100. |
| status optional	 | Only return agents that have the given status: active or inactive. |
| page optional | Returns all the agents within the page |


**Returns**  A dictionary with a `data` property that contains an array of up to `limit` agents and when you pass `page`  it will return you all the entries in the respective page.Passing an optional `status` will result in filtering to agents with only that exact status. Each entry in the array is a separate agent object. If no more agents are available, the resulting array will be empty. If you provide a non-existent filter, this call returns an error.## Endpoints:
- Sandbox: https://api-test.lotuspay.com/v1/agents

- Production: https://api.lotuspay.com/v1/agents

## Request Type: 
GET

## Content-Type: 
application/json

## Authorization:

#### Basic Auth:
Auth example
- Value:  sk_test_XjIHowXWSI23uvjepz2X82
## Sample Code Snippets:
### Sample Request and Response:

#### Request:
```Shell
{
  "id": "AG0011DD2211AA",
  "object": "agent",
  "created": 1530224170,
  "livemode": false,
  "code": "EMPLOYEE1",
  "email": "test+1@lotuspay.com",
  "identification": "EMPLOYEE1",
  "mobile": "9876543210",
  "name": "TEST AGENT1",
  "status": "active"
}

```

#### Response:
```json
{
    "object": "list",
    "url": "/v1/agents",
    "has_more": false,
    "data": [
          {
              "id": "AG004433221AA",
              "code": "EMPLOYEE1",
              "email": "test+1@lotuspay.com",
              "identification": "EMPLOYEE1",
              "mobile": "9876543210",
              "name": "TEST AGENT1",
              "status": "active"
          },
          {
              "id": "AG004433221BB",
              "code": "EMPLOYEE2",
              "email": "test+2@lotuspay.com",
              "identification": "EMPLOYEE2",
              "mobile": "9876543211",
              "name": "TEST AGENT2",
              "status": "active"
          },
          {
              "id": "AG004433221CC",
              "code": "EMPLOYEE3",
              "email": "test+3@lotuspay.com",
              "identification": "EMPLOYEE3",
              "mobile": "9876543212",
              "name": "TEST AGENT3",
              "status": "active"
          }
    ]
  }
```

## API Responses: