Skip to main content
GET
/
api
/
v2
/
companies
/
List companies
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>",
      "is_branch": true,
      "branch_name": "<string>",
      "is_public": true,
      "is_active": true,
      "loyalty_programs_count": 123,
      "active_customers_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "zupy_balance": "<string>",
      "program_setup_completed": true,
      "airdrop_claimed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Query Parameters

cursor
string

Pagination cursor value from previous response.

page_size
integer

Number of results to return per page.

Response

data
object[]
required
meta
object
required