PayPilot API
Live demoGitHub
HomeGuidesSDKsContext PluginAPI Reference
Growth

List competitors

GET
/api/v1/competitors

List competitors.

Authorization

HTTPBearer
AuthorizationBearer <token>

JWT access token

In: header

Query Parameters

merchant_id?|

Optional merchant to act on. Must be one you are a member of.

Formatuuid

Header Parameters

X-Merchant-ID?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/competitors"
{  "data": [    {}  ],  "meta": {},  "success": true}

Inventory and margin signals that shape growth recommendations GET

Inventory and margin signals that shape growth recommendations.

Competitor intelligence GET

Perception comparison across speed, service, quality, taste, price, packaging and ambience. Competitor data is representative baseline data - no platform is scraped.