GET/api/appointments/{id}

Buscar Agendamentos

Busca agendamentos com base em filtros

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

idOBRIGATÓRIO
Tipo:number
ID do agendamento

Este parâmetro representa o identificador único do agendamento. O ID do agendamento deve ser um número inteiro que identifica um agendamento específico no sistema.

Observação: Para encontrar o ID do agendamento, para acessar a página de listar agendamentos.

Request URL

https://api-dev.imagemais.com/api/appointments/11

Respostas

{
  "data": {
    "id": 11,
  ...
{
  "data": {
    "id": 11,
    "date": "2024-01-15T00:00:00.000Z",
    "startTime": "09:00",
    "endTime": "09:05",
    "notes": "Observações sobre o agendamento",
    "doctorId": 1,
    "accountId": 1,
    "createdAt": "2025-12-02T18:21:29.276Z",
    "updatedAt": "2025-12-02T18:21:29.276Z",
    "patient": {
      "name": "João Silva",
      "cpf": null,
      "dateBirth": "1990-01-01T00:00:00.000Z",
      "contact": {
        "phone": "(81) 99999-9999"
      }
    },
    "doctor": {
      "name": "Dr Victor",
      "intervalMinutes": 5,
      "doctorProcedures": [
        {
          "doctorId": 1,
          "procedureId": 3644,
          "createdAt": "2025-12-02T17:31:41.387Z",
          "updatedAt": "2025-12-12T14:54:51.872Z",
          "deletedAt": null,
          "procedure": {
            "id": 3644,
            "name": "Ultrassom: Abdome Total",
            "price": "140",
            "discounts": [
              {
                "id": 7,
                "name": "Desconto de 20%",
                "fixed": null,
                "percentage": 20,
                "expirationDate": null
              },
              {
                "id": 3,
                "name": "Desconto nos procedimentos",
                "fixed": "10",
                "percentage": null,
                "expirationDate": null
              }
            ]
          }
        },
        {
          "doctorId": 1,
          "procedureId": 3692,
          "createdAt": "2025-12-02T17:31:41.387Z",
          "updatedAt": "2025-12-12T14:54:51.872Z",
          "deletedAt": null,
          "procedure": {
            "id": 3692,
            "name": "Ultrassom: Morfologico 2/3 Trimestre Doppler Uterinas",
            "price": "250",
            "discounts": []
          }
        },
        {
          "doctorId": 1,
          "procedureId": 3699,
          "createdAt": "2025-12-02T17:31:41.387Z",
          "updatedAt": "2025-12-12T14:54:51.872Z",
          "deletedAt": null,
          "procedure": {
            "id": 3699,
            "name": "Ultrassom: Tireoide",
            "price": "100",
            "discounts": [
              {
                "id": 3,
                "name": "Desconto nos procedimentos",
                "fixed": "10",
                "percentage": null,
                "expirationDate": null
              }
            ]
          }
        }
      ]
    },
    "appointmentProcedures": {
      "id": 10,
      "price": "0",
      "discountsAppointmentProcedures": [],
      "procedure": {
        "id": 1,
        "name": "string",
        "price": "0",
        "discounts": []
      }
    },
    "status": {
      "name": "Agendado",
      "color": "#ffc107"
    },
    "movements": []
  }
}
{
  "data": {
    "id": 40,
  ...
{
  "data": {
    "id": 40,
    "date": "2025-09-04T00:00:00.000Z",
    "startTime": "12:20",
    "endTime": "12:30",
    "notes": "",
    "accountId": 1,
    "createdAt": "2025-12-18T14:55:38.899Z",
    "updatedAt": "2025-12-18T14:57:25.484Z",
    "deletedAt": null,
    "doctor": {
      "workingDays": [
        "sex",
        "qui"
      ],
      "startTime": "12:00",
      "endTime": "15:00",
      "intervalMinutes": 10,
      "id": 2,
      "name": "Dr Victoriano"
    },
    "patient": {
      "dateBirth": "2000-01-02T00:00:00.000Z",
      "id": 9308,
      "name": "dada",
      "contact": {
        "phone": "(89) 12313-1313"
      }
    },
    "status": {
      "id": 1,
      "name": "Agendado",
      "color": "#ffc107"
    },
    "appointmentProcedures": {
      "price": "100",
      "discountsAppointmentProcedures": [
        {
          "discount": {
            "id": 3,
            "name": "Desconto nos procedimentos",
            "fixed": "10",
            "percentage": null,
            "expirationDate": null
          }
        }
      ],
      "procedure": {
        "id": 3699,
        "name": "Ultrassom: Tireoide",
        "price": "100"
      }
    }
  }
}
{
  "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"
}