Skip to main content
GET
/
company
Get Company Information
curl --request GET \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/company/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "1474883d96603e4914ef43bb135",
  "name": "Miola Smash Burger",
  "trading_name": "Miola Smash Burger",
  "email": "[email protected]",
  "phone": "(11) 98574-9872",
  "website": "https://miolaburger.com.br/",
  "logo": "https://cdn.zupy.com/media/company_files/logo-miola-smash-burger.jpg",
  "description": "Miola Burger Hamburgueria Artesanal",
  "business_type": "Hamburgueria",
  "currency": "BRL",
  "cnpj": "35.251.614/0001-20",
  "address": null,
  "loyalty_programs_count": 1,
  "active_customers_count": 1022,
  "created_at": "2025-03-28T17:02:53.092523Z",
  "active": true
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Response

Company information retrieved successfully

​
id
string
Example:

"1474883d96603e4914ef43bb135"

​
name
string
Example:

"Miola Smash Burger"

​
trading_name
string
Example:

"Miola Smash Burger"

​
email
string<email>
​
phone
string
Example:

"(11) 98574-9872"

​
website
string<uri>
Example:

"https://miolaburger.com.br/"

Example:

"https://cdn.zupy.com/media/company_files/logo-miola-smash-burger.jpg"

​
description
string
Example:

"Miola Burger Hamburgueria Artesanal"

​
business_type
string
Example:

"Hamburgueria"

​
currency
string
Example:

"BRL"

​
cnpj
string
Example:

"35.251.614/0001-20"

​
address
string | null
Example:

null

​
loyalty_programs_count
integer
Example:

1

​
active_customers_count
integer
Example:

1022

​
created_at
string<date-time>
Example:

"2025-03-28T17:02:53.092523Z"

​
active
boolean
Example:

true