curl --request GET \
--url https://api.zupy.com/api/v2/companies/ \
--header 'X-API-Key: <api-key>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"trading_name": "<string>",
"slug": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"website": "<string>",
"logo_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_color": "<string>",
"secondary_color": "<string>",
"social_links": "<unknown>",
"instagram_url": "<string>",
"google_review_url": "<string>",
"menu_url": "<string>",
"survey_url": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"business_type": "<string>",
"description": "<string>",
"currency": "<string>",
"subscription_tier": "essential",
"is_branch": true,
"branch_name": "<string>",
"is_public": true,
"status": "active",
"is_active": true,
"loyalty_programs_count": 123,
"active_customers_count": 123,
"subscription_status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}List all companies accessible to the authenticated user.
curl --request GET \
--url https://api.zupy.com/api/v2/companies/ \
--header 'X-API-Key: <api-key>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"trading_name": "<string>",
"slug": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"website": "<string>",
"logo_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_color": "<string>",
"secondary_color": "<string>",
"social_links": "<unknown>",
"instagram_url": "<string>",
"google_review_url": "<string>",
"menu_url": "<string>",
"survey_url": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"business_type": "<string>",
"description": "<string>",
"currency": "<string>",
"subscription_tier": "essential",
"is_branch": true,
"branch_name": "<string>",
"is_public": true,
"status": "active",
"is_active": true,
"loyalty_programs_count": 123,
"active_customers_count": 123,
"subscription_status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}API key for partner access via APISIX key-auth plugin
Pagination cursor value from previous response.
Number of results to return per page.