Quem sou eu

GET

/v1/me

const url = 'https://developers.nexo.winningsales.com.br/v1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

A pessoa dona do token, o papel dela, a empresa, o próprio token (escopos e validade) e os limites de chamadas. Use para conferir se o token funciona e o que ele enxerga.

Authorizations

bearer

Responses

200

Dono do token, empresa, token e limites

application/json

object

user

required

object

required

Id da pessoa dona do token

string format: uuid

name

required

Nome da pessoa

string

email

required

E-mail da pessoa

string

role

required

Papel na empresa; define o que a pessoa enxerga, igual no app

string

Allowed values: admin sales_lead rep

company

required

object

required

Id da empresa

string format: uuid

name

required

Nome da empresa

string

timezone

required

Fuso horário IANA da empresa: “hoje” e “este mês” são calculados nele

string

credential

required

object

required

Id do token usado nesta chamada

string format: uuid

name

required

Nome do token

string

kind

required

Tipo da credencial (pat = token pessoal)

string

scopes

required

Escopos do token

Array<string>

expiresAt

required

Quando o token expira

string format: date-time

rateLimits

required

Limites por classe de operação: o da empresa vale para todos os tokens dela somados; o do token, só para ele

object

key

additional properties

object

company

required

object

limit

required

Chamadas permitidas na janela

integer

windowSeconds

required

Tamanho da janela em segundos

integer

burst

required

Rajada máxima de chamadas seguidas

integer

credential

required

object

limit

required

Chamadas permitidas na janela

integer

windowSeconds

required

Tamanho da janela em segundos

integer

burst

required

Rajada máxima de chamadas seguidas

integer

Example

{
  "user": {
    "role": "admin"
  }
}

401

Token ausente, inválido, expirado ou revogado

application/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

application/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

application/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
  }
}