Listar modelos de documento - Westhetics · Desenvolvedores

GET

/

v1

/

templates

Listar modelos de documento

curl --request GET \
  --url https://api.westhetics.io/v1/templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.westhetics.io/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Termo de consentimento · preenchimento com ácido hialurônico",
      "category": "informed_consent",
      "audience": "patient",
      "isIncluded": false,
      "versionLabel": "3",
      "linkedProcedures": [
        {
          "id": "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e",
          "name": "Preenchimento labial"
        }
      ]
    }
  ],
  "meta": {
    "limit": 25,
    "nextCursor": null
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

Autorizações

Authorization

string

header

obrigatório

A chave do app de integração, criada em Integrações. Escopos: patients:read (Listar, buscar e ler pacientes; os eventos patient..); patients:write (Criar e editar pacientes. Inclui ler.); anamneses:read (Listar e ler anamneses, sem as respostas; os eventos anamnesis..); anamneses:write (Enviar, reenviar e cancelar anamnese. Inclui ler.); anamneses:answers (Ler as respostas da anamnese preenchida. É dado de saúde.); documents:read (Atendimentos, documentos, status da assinatura e o PDF; os eventos appointment.* e signature_request.*.); documents:write (Gerar contrato e termos e enviar para assinatura, reenviar e cancelar. Inclui ler.); catalog:read (Procedimentos, prestadores e modelos de documento da clínica.); webhooks:write (Criar, alterar e remover os webhooks do próprio app pela API.)

Parâmetros de consulta

flow

enum<string>

padrão:procedure

Opções disponíveis:

procedure,

standalone

Resposta

Sucesso.

data

object[]

obrigatório

Show child attributes

meta

object

obrigatório

A página de uma lista por cursor.

Show child attributes

Listar modelos de documento

curl --request GET \
  --url https://api.westhetics.io/v1/templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.westhetics.io/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Termo de consentimento · preenchimento com ácido hialurônico",
      "category": "informed_consent",
      "audience": "patient",
      "isIncluded": false,
      "versionLabel": "3",
      "linkedProcedures": [
        {
          "id": "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e",
          "name": "Preenchimento labial"
        }
      ]
    }
  ],
  "meta": {
    "limit": 25,
    "nextCursor": null
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}