List outlets (cursor)

Developing

GET

/outlets

Returns outlets for a scrollable table with filters, sorting, and cursor-based pagination.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in cookie

access_token

Example:

access_token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://mock.apidog.com/m1/1052146-0-default/outlets?cursor&limit&search&sortKey&sortDir&type&status' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "code": "LOGIN_OK",
    "message": "Authenticated",
    "data": {
        "rows": [
            {
                "id": 101,
                "name": "Ikeja Main Store",
                "type": "sales",
                "numberOfProduct": 1420,
                "stockValue": 124500000,
                "retailValue": 182900000,
                "growth": 0.12,
                "status": "active"
            }
        ],
        "nextCursor": "string",
        "hasNext": true
    },
    "meta": {
        "page": 1,
        "perPage": 50,
        "total": 1
    }
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-10-03 10:43:15

Delete Outlet

Outlets summary