Skip to main content
GET
Leitura de documento anexado

Authorizations

Authorization
string
header
required

Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave.

Path Parameters

id
string<uuid>
required

UUID da proposta.

attachmentId
string<uuid>
required

UUID do anexo. O anexo precisa pertencer à proposta informada em id.

Query Parameters

version_scope
enum<string>

DRAFT lê o rascunho atual e PUBLISHED a versão publicada.

Available options:
DRAFT,
PUBLISHED

Response

Metadados do documento e páginas na ordem de leitura.

attachment_id
string<uuid>
version_scope
enum<string>

Versão efetivamente lida.

Available options:
DRAFT,
PUBLISHED
document
object
pages
object[]

Páginas na ordem de leitura: cada página é seguida das suas subpáginas.