GET/api/patients

Listar Pacientes

Lista todos os pacientes

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}

Parâmetros

limitOPCIONAL
Tipo:number
Limite de pacientes a serem retornados
offsetOPCIONAL
Tipo:number
Offset de pacientes a serem retornados
nameOPCIONAL
Tipo:string
Nome do paciente

Este parâmetro representa o nome do paciente que será utilizado na requisição. O nome é obrigatório e deve ser uma string válida.

Atenção: Caso o campo name seja removido da requisição, não seja fornecido ou esteja vazio, a API retornará um erro 400 Bad Request

cpfOPCIONAL
Tipo:string
CPF do paciente

Este parâmetro representa o CPF do paciente. O campo é opcional e pode ser omitido na requisição sem causar erros.

Observação sobre o CPF: O campo cpf é opcional. Caso não seja fornecido na requisição, o paciente será criado normalmente. No entanto, se o campo cpf for informado de forma inválida (formato incorreto, quantidade de caracteres insuficiente ou valores não numéricos), a API retornará um erro 400 Bad Request.

Atenção: Não é possível criar um paciente com o mesmo CPF. Caso seja fornecido um CPF que já existe no sistema, a API retornará um erro 409 Conflict com a mensagem: "Já existe um paciente com esse CPF".

rgOPCIONAL
Tipo:string
RG do paciente
deletedOPCIONAL
Tipo:boolean
Filtro de deletado
phoneOPCIONAL
Tipo:string
Telefone do paciente

Request URL

https://api-dev.imagemais.com/api/patients?limit=5&offset=0&name=Roberto&cpf=099.742.334-01&rg=10.970.901&phone=%2881%29%2099357-5588

Respostas

[
  {
    "id": 9267,
  ...
[
  {
    "id": 9267,
    "name": "ROBERTOO",
    "gender": {
      "name": "M"
    },
    "dateBirth": "2000-01-02T00:00:00.000Z",
    "rg": null,
    "cpf": "09974233401",
    "address": {
      "street": null,
      "number": null,
      "district": null,
      "city": null,
      "state": null,
      "cep": null,
      "complement": null
    },
    "contact": {
      "phone": "81993575588",
      "secondary_phone": null,
      "email": null
    },
    "createdAt": "2025-12-04T14:08:26.676Z",
    "updatedAt": "2025-12-04T14:24:45.441Z",
    "deletedAt": null
  },
  {
    "id": 9266,
    "name": "João da Silva",
    "gender": null,
    "dateBirth": null,
    "rg": null,
    "cpf": "11111111111",
    "address": {
      "street": null,
      "number": null,
      "district": null,
      "city": null,
      "state": null,
      "cep": null,
      "complement": null
    },
    "contact": {
      "phone": "",
      "secondary_phone": null,
      "email": null
    },
    "createdAt": "2025-12-03T18:50:22.903Z",
    "updatedAt": "2025-12-03T18:50:22.903Z",
    "deletedAt": null
  },
  {
    "id": 9265,
    "name": "João da Silva",
    "gender": null,
    "dateBirth": null,
    "rg": null,
    "cpf": "11111111111",
    "address": {
      "street": null,
      "number": null,
      "district": null,
      "city": null,
      "state": null,
      "cep": null,
      "complement": null
    },
    "contact": {
      "phone": "81999999999",
      "secondary_phone": null,
      "email": null
    },
    "createdAt": "2025-12-03T18:49:46.538Z",
    "updatedAt": "2025-12-03T18:49:46.538Z",
    "deletedAt": null
  }
]
[
  {
    "id": 9267,
  ...
[
  {
    "id": 9267,
    "name": "ROBERTOO",
    "gender": {
      "name": "M"
    },
    "dateBirth": "2000-01-02T00:00:00.000Z",
    "rg": "10.970.901",
    "cpf": "09974233401",
    "address": {
      "street": null,
      "number": null,
      "district": null,
      "city": null,
      "state": null,
      "cep": null,
      "complement": null
    },
    "contact": {
      "phone": "81993575588",
      "secondary_phone": null,
      "email": null
    },
    "createdAt": "2025-12-04T14:08:26.676Z",
    "updatedAt": "2025-12-05T11:34:57.147Z",
    "deletedAt": null
  }
]
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}