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
Scroll inside to view more
|
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.
Request
Response
API Endpoints
Sandbox Link
GET
https://api-test.lotuspay.com/v1/agents
Production Link
GET
https://api.lotuspay.com/v1/agents