Dados da empresa

GET

/v1/company

curl --request GET \
  --url https://developers.nexo.winningsales.com.br/v1/company \
  --header 'Authorization: Bearer <token>'

Nome, fuso horário (IANA), modo de venda declarado e período do valor declarado dos negócios. “Hoje” e “este mês” de toda a API são calculados no fuso da empresa.

Authorizations

• bearer

Responses

200

Os dados da empresa

Media typeapplication/json

object

name

required

Company display name

string

timezone

required

IANA time zone the company lives in, e.g. America/Sao_Paulo. Every “today”, “at 7am” and monthly pace is computed in it

string

salesMotion

required

How the company sells, declared by an admin: self-serve, inside-sales (remote, consultative), field-sales or hybrid. It calibrates the lens

string

nullable

Allowed values: self-serve inside-sales field-sales hybrid

declaredValuePeriod

required

Period the CRM deal amount represents, declared by an admin: monthly (annualized ×12), annual or total (whole-contract value, taken as annual). It anchors the ticket scale used by the lens over any inferred signal

string

nullable

Allowed values: monthly annual total

Example

{
  "salesMotion": "self-serve",
  "declaredValuePeriod": "monthly"
}

401

Token ausente, inválido, expirado ou revogado

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

429

Limite de chamadas da empresa ou do token atingido

Media typeapplication/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}