> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar pessoa
> Retorna a pessoa correspondente ao ID.
`people:read`
## OpenAPI
````yaml /pt/api-reference/openapi.json get /v1/people/{id}
openapi: 3.1.0
info:
title: OAuth 2.1
description: Endpoints para registrar aplicativos e gerenciar tokens OAuth 2.1.
version: 1.0.0
contact:
name: Suporte Vendaze
email: suporte@vendaze.com
servers:
- url: https://api.vendaze.com
description: Produção
security:
- bearerAuth: []
tags:
- name: OAuth
- name: Pessoas
- name: Empresas
- name: Negócios
- name: Pipelines
- name: Tarefas
- name: Tipos de Tarefas
- name: Produtos
- name: Tags
- name: Listas
- name: Campos Adicionais
- name: Webhooks
paths:
/v1/people/{id}:
get:
tags:
- Pessoas
summary: Buscar pessoa
description: |-
Retorna a pessoa correspondente ao ID.
`people:read`
operationId: getPerson
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: Pessoa retornada com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/PersonWithEmbeddedResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/InsufficientScope'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
components:
parameters:
id:
name: id
in: path
required: true
schema:
type: string
format: uuid
description: UUID do recurso.
schemas:
PersonWithEmbeddedResponse:
type: object
properties:
data:
$ref: '#/components/schemas/PersonWithEmbedded'
PersonWithEmbedded:
allOf:
- $ref: '#/components/schemas/Person'
- type: object
properties:
company:
type: object
nullable: true
properties:
id:
type: string
format: uuid
full_name:
type: string
emails:
type: array
nullable: true
items:
type: object
properties:
email:
type: string
type:
type: string
phones:
type: array
nullable: true
items:
type: object
properties:
phone:
type: string
type:
type: string
avatar_url:
type: string
nullable: true
entity_id:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
lists:
type: array
items:
$ref: '#/components/schemas/ContactList'
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldValue'
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
request_id:
type: string
format: uuid
Person:
type: object
properties:
id:
type: string
format: uuid
full_name:
type: string
maxLength: 70
example: Maria Silva
emails:
type: array
nullable: true
items:
$ref: '#/components/schemas/ContactEmail'
example:
- email: maria@empresa.com
type: work
phones:
type: array
nullable: true
items:
$ref: '#/components/schemas/ContactPhone'
example:
- phone: '+5511999990001'
type: mobile
company_id:
type: string
format: uuid
nullable: true
owner:
$ref: '#/components/schemas/Owner'
position:
type: string
nullable: true
example: Head of Sales
score:
type: number
minimum: 0
maximum: 5
example: 0
readOnly: true
description: Somente leitura. Gerenciado internamente pela Vendaze.
avatar_url:
type: string
format: uri
nullable: true
example: >-
https://storage.vendaze.com/client/workspaces/abc/people/xyz/avatar/avatar_WWT1BGs9ma.webp
entity_id:
type: string
example: g7wwkh0
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
Tag:
type: object
properties:
id:
type: string
format: uuid
description: Identificador único da tag.
name:
type: string
maxLength: 30
description: Nome de exibição da tag.
example: Lead Quente
key:
type: string
maxLength: 30
description: >-
Chave única no workspace. Apenas letras minúsculas, dígitos e
underscores (ex: `lead_quente`). Usada para referenciar a tag nos
arrays de associação.
example: lead_quente
color_text:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
Cor do texto em formato hex RGB. `null` significa que o padrão do
workspace é aplicado.
example: '#ffffff'
color_background:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
Cor de fundo em formato hex RGB. `null` significa que o padrão do
workspace é aplicado.
example: '#ef4444'
created_at:
type: string
format: date-time
description: Timestamp ISO 8601 UTC de criação da tag.
ContactList:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
created_at:
type: string
format: date-time
CustomFieldValue:
type: object
properties:
id:
type: string
format: uuid
value: {}
field:
type: object
properties:
id:
type: string
format: uuid
label:
type: string
key:
type: string
type:
type: string
ContactEmail:
type: object
required:
- email
properties:
email:
type: string
format: email
example: contato@acme.com
type:
type: string
enum:
- personal
- work
- other
description: Tipo do e-mail.
example: work
ContactPhone:
type: object
required:
- phone
properties:
phone:
type: string
example: '+551130000000'
type:
type: string
enum:
- mobile
- work
- residential
- other
description: Tipo do telefone.
example: work
Owner:
type: object
nullable: true
description: >-
Membro do workspace responsável pela tarefa. `null` quando nenhum
responsável está atribuído.
properties:
id:
type: string
format: uuid
name:
type: string
example: João Silva
email:
type: string
format: email
example: joao@empresa.com.br
responses:
Unauthorized:
description: >-
Token ausente, inválido ou expirado. Códigos possíveis: `unauthorized`,
`token_expired`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: unauthorized
message: Missing or invalid Authorization header.
request_id: 550e8400-e29b-41d4-a716-446655440000
InsufficientScope:
description: 'Token sem o escopo necessário. Código de erro: `insufficient_scope`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: insufficient_scope
message: This endpoint requires the 'webhooks:read' scope.
request_id: 550e8400-e29b-41d4-a716-446655440000
NotFound:
description: >-
Webhook não encontrado ou pertence a outra integração. Código:
`not_found`. Mensagem: `"Webhook not found."`
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: not_found
message: Webhook not found.
request_id: 550e8400-e29b-41d4-a716-446655440000
InternalError:
description: 'Erro interno inesperado. Código: `internal_error`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: internal_error
message: An unexpected error occurred.
request_id: 550e8400-e29b-41d4-a716-446655440000
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Access token OAuth 2.1.
````