GET /project/{project_id}/get-catalog — List Catalogues

Use this endpoint to retrieve all product catalogues linked to your Convo project. Results are paginated and can be filtered by product count.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/project/{project_id}/get-catalog

Authentication

X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD

Path Parameters

string

required

Your Convo project ID.

Query Parameters

integer

Maximum number of catalogues to return per page. Defaults to 20.

integer

Number of records to skip for offset-based pagination. Defaults to 0.

integer

Filter catalogues by an exact product count. Omit this parameter to return catalogues regardless of product count.

Request Example

curl "https://connect.api-wa.co/project-apis/v1/project/YOUR_PROJECT_ID/get-catalog?limit=20&skip=0" \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response

Returns a catalogues array containing catalogue objects.

array

Array of catalogue objects. Each object contains:

Show Catalogue Object

string

Internal database ID of the catalogue record.

string

The Meta catalogue ID as registered with your WhatsApp Business Account.

string

Display name of the catalogue.

integer

Total number of products in this catalogue.

integer

Number of product feeds associated with this catalogue.

string

The product vertical/category for this catalogue (e.g., "commerce", "hotels").

boolean

Whether this catalogue is currently active on your WhatsApp Business Account.

string

Current sync/approval status of the catalogue.

Example Response

{
  "catalogues": [
    {
      "_id": "64b3e1a2c4f1a234560d1a2b",
      "catalogueId": "738763614338341",
      "catalogueName": "Summer Collection 2024",
      "productCount": 48,
      "feedCount": 2,
      "vertical": "commerce",
      "isActive": true,
      "status": "active"
    },
    {
      "_id": "64b3e1a2c4f1a234560d1a3c",
      "catalogueId": "849874625449452",
      "catalogueName": "Winter Essentials",
      "productCount": 22,
      "feedCount": 1,
      "vertical": "commerce",
      "isActive": false,
      "status": "pending"
    }
  ]
}

Error Responses

Status Code	Description
`500`	Internal Server Error — An unexpected server-side error occurred. Retry the request or contact support.

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

GET /project/{project_id}/get-catalog — List Catalogues

Endpoint

Authentication

Path Parameters

Query Parameters

Request Example

Response

Example Response

Error Responses

​Endpoint

​Authentication

​Path Parameters

​Query Parameters

​Request Example

​Response

​Example Response

​Error Responses

Endpoint

Authentication

Path Parameters

Query Parameters

Request Example

Response

Example Response

Error Responses