Skip to main content
GET
/
categories
List categories
curl --request GET \
  --url https://api.salesive.com/api/v1/categories \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Categories retrieved",
  "data": {
    "categories": [
      {
        "_id": "6651ab12cd34ef56ab78cd90",
        "name": "Electronics",
        "slug": "electronics",
        "description": "Phones, audio and accessories",
        "image": "https://cdn.example.com/c/electronics.png",
        "deleted": false,
        "deletedAt": null,
        "shop": "664f0e2a1c2b3d4e5f6a7b8c",
        "createdAt": "2026-04-10T12:00:00.000Z",
        "updatedAt": "2026-06-01T08:00:00.000Z",
        "id": "6651ab12cd34ef56ab78cd90",
        "productCount": 24
      }
    ],
    "page": 1,
    "pages": 3,
    "total": 12
  }
}
Returns the store’s product categories newest first, each with a productCount, plus optional free-text search across name and description. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

​
page
integer
default:1

1-based page number.

Required range: x >= 1
​
limit
integer
default:5

Items per page. Defaults to 5.

Required range: x >= 1
​
search
string

Case-insensitive substring match against category name and description.

Response

Paginated list of categories.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

Flat pagination metadata returned alongside the items array on list responses.