{"info":{"_postman_id":"e8d9b97f-1d9f-4a75-b2a9-4e6af861f7a7","name":"api.consultoriome.com","description":"

What does the API do? (English)

Lists appointments for sending reminders.
\n
Allows confirming or canceling appointments.
\n
Lists birthdays for sending messages.
\n
Lists a professional's available schedules.
\n
Allows booking appointments.
\n

O que a API faz? (Português)

Lista os agendamentos para o envio de lembretes.
\n
Permite confirmar ou cancelar agendamentos.
\n
Lista os aniversários para o envio de mensagens.
\n
Lista os horários disponíveis de um profissional.
\n
Permite agendar consultas.
\n

¿Qué hace la API? (Español)

Lista las citas para el envío de recordatorios.
\n
Permite confirmar o cancelar citas.
\n
Lista los cumpleaños para el envío de mensajes.
\n
Lista los horarios disponibles de un profesional.
\n
Permite agendar consultas.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1116511","collectionId":"e8d9b97f-1d9f-4a75-b2a9-4e6af861f7a7","publishedId":"2sA2rAyN3Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-22T18:21:14.000Z"},"item":[{"name":"token","id":"ac7b8d3b-fce5-4d50-95e5-6058e87eae74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{clientid}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.consultoriome.com/v1/api/authorization/token","description":"

Obtains the authentication token according to the ClientId and Secret that were obtained in the Settings area of https://consultorio.me

The generated token is valid for 24 hours, but if necessary for your workflow, you can generate a new token for each request.

Path to get the keys:
Settings → More Settings → Scroll Down → API → Show API Keys

Obtém o token de autenticação de acordo com o ClientId e o Secret obtidos na área de Configurações de https://consultorio.me

O token gerado é válido por 24 horas, mas, se necessário para o seu fluxo de trabalho, você pode gerar um novo token para cada solicitação.

Caminho para obter as chaves:
Configurações → Mais configurações → Role para baixo → API → Mostrar chaves da API

Obtiene el token de autenticación según el ID de cliente y el secreto obtenidos en la sección Configuración de https://consultorio.me.

El token generado tiene una validez de 24 horas, pero si su flujo de trabajo lo requiere, puede generar uno nuevo para cada solicitud.

Ruta para obtener las claves:
Ajustes → Más configuraciones → Desplazarse hacia abajo → API → Mostrar claves API

","urlObject":{"protocol":"https","path":["v1","api","authorization","token"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"e1fd5914-70de-4f77-9a07-6ca2b6dddfe3","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/authorization/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"string"},{"id":"8d5e22be-26ff-4a75-84c6-e8906a4e2e08","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/authorization/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"f18f905e-e9dc-432f-87fd-d6fab0a34267","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/authorization/token"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"ac7b8d3b-fce5-4d50-95e5-6058e87eae74"},{"name":"appointments","id":"3a404369-bf2a-4b91-8aa2-a79756469393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/messenger/appointments/{{date}}/{{templateid}}","description":"

Gets the appointments according to the date informed for sending reminders.

Enter the parameter in the URL with the appointment date in the format YYYY-MM-DD (ex. 2025-05-30)

It is also possible to enter a template ID at the end of the URL, to bring the message ready.

\n","urlObject":{"protocol":"https","path":["v1","api","messenger","appointments","{{date}}","{{templateid}}"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"2d3afece-2779-4de3-95b6-00f9132dc993","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/appointments/:date/:messageId","host":["{{baseUrl}}"],"path":["v1","api","messenger","appointments",":date",":messageId"],"variable":[{"key":"date","value":"string"},{"key":"messageId","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"string\",\n \"Date\": \"1960-10-20T08:27:26.717Z\",\n \"Type\": \"string\",\n \"PatientName\": \"string\",\n \"Phone1\": \"string\",\n \"PhoneNumber1\": \"string\",\n \"Phone2\": \"string\",\n \"PhoneNumber2\": \"string\",\n \"Email\": \"string\",\n \"PatientExtraField1\": \"string\",\n \"PatientExtraField2\": \"string\",\n \"ClinicName\": \"string\",\n \"ClinicAddress\": \"string\",\n \"ClinicLocation\": \"string\",\n \"ProfessionalName\": \"string\",\n \"ProfessionalExtraInfo\": \"string\",\n \"ProfessionalCredentials\": \"string\",\n \"LinkCreateAppointment\": \"string\",\n \"LinkConfirmation\": \"string\",\n \"LinkMeeting\": \"string\",\n \"Message\": \"string\",\n \"CustomMessageId\": 2084,\n \"Forms\": [\n {\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"Url\": \"string\"\n },\n {\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"Url\": \"string\"\n }\n ]\n },\n {\n \"Id\": \"string\",\n \"Date\": \"1985-01-15T10:23:19.402Z\",\n \"Type\": \"string\",\n \"PatientName\": \"string\",\n \"Phone1\": \"string\",\n \"PhoneNumber1\": \"string\",\n \"Phone2\": \"string\",\n \"PhoneNumber2\": \"string\",\n \"Email\": \"string\",\n \"PatientExtraField1\": \"string\",\n \"PatientExtraField2\": \"string\",\n \"ClinicName\": \"string\",\n \"ClinicAddress\": \"string\",\n \"ClinicLocation\": \"string\",\n \"ProfessionalName\": \"string\",\n \"ProfessionalExtraInfo\": \"string\",\n \"ProfessionalCredentials\": \"string\",\n \"LinkCreateAppointment\": \"string\",\n \"LinkConfirmation\": \"string\",\n \"LinkMeeting\": \"string\",\n \"Message\": \"string\",\n \"CustomMessageId\": 9676,\n \"Forms\": [\n {\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"Url\": \"string\"\n },\n {\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"Url\": \"string\"\n }\n ]\n }\n]"},{"id":"0c2fa506-a1bc-4260-bb1f-022780875b91","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/appointments/:date/:messageId","host":["{{baseUrl}}"],"path":["v1","api","messenger","appointments",":date",":messageId"],"variable":[{"key":"date","value":"string"},{"key":"messageId","value":"0"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"39b21a91-7aa7-495d-8e56-8ebdd75b1578","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/appointments/:date/:messageId","host":["{{baseUrl}}"],"path":["v1","api","messenger","appointments",":date",":messageId"],"variable":[{"key":"date","value":"string"},{"key":"messageId","value":"0"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"3a404369-bf2a-4b91-8aa2-a79756469393"},{"name":"birthdays","id":"c42f2a16-8923-4861-89ae-5e76e111c434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/messenger/birthdays/{{date}}","description":"

Gets the birthdays according to the date entered in the URL parameter.

The date format must be YYYY-MM-DD.

\n","urlObject":{"protocol":"https","path":["v1","api","messenger","birthdays","{{date}}"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"33b5bf94-ed21-4de7-8e54-588b7f593dc8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/birthdays/:date","host":["{{baseUrl}}"],"path":["v1","api","messenger","birthdays",":date"],"variable":[{"key":"date","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Name\": \"string\",\n \"Birthday\": \"1978-11-20T04:40:29.984Z\",\n \"Phone1\": \"string\",\n \"Phone2\": \"string\",\n \"Email\": \"string\"\n },\n {\n \"Name\": \"string\",\n \"Birthday\": \"1948-08-23T12:16:33.395Z\",\n \"Phone1\": \"string\",\n \"Phone2\": \"string\",\n \"Email\": \"string\"\n }\n]"},{"id":"73368a2e-af7e-4953-8660-6f44e1a6a48a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/birthdays/:date","host":["{{baseUrl}}"],"path":["v1","api","messenger","birthdays",":date"],"variable":[{"key":"date","value":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"c8a0f72e-671b-42f2-a978-fab58b1ebb63","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/birthdays/:date","host":["{{baseUrl}}"],"path":["v1","api","messenger","birthdays",":date"],"variable":[{"key":"date","value":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"c42f2a16-8923-4861-89ae-5e76e111c434"},{"name":"templates","id":"597be2da-a93f-49e8-9eae-75a4579faea9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/messenger/templates/whatsapp","description":"

Gets message templates with keywords.

This method allows you to know the ID of the message template you intend to send.

It is not mandatory to use a message template, you can just obtain the data and generate the message in your client.

Template IDs with a negative number are the default templates and cannot be changed.

Use the parameter \"whatsapp\" or \"sms\" in the end of the URL to receive the templates.

\n","urlObject":{"protocol":"https","path":["v1","api","messenger","templates","whatsapp"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"49c94aa9-b83e-4e01-af87-b54ae7a53cb3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/templates/:type","host":["{{baseUrl}}"],"path":["v1","api","messenger","templates",":type"],"variable":[{"key":"type","value":"whatsapp"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 4034,\n \"Name\": \"string\",\n \"Text\": \"string\"\n },\n {\n \"Id\": 985,\n \"Name\": \"string\",\n \"Text\": \"string\"\n }\n]"},{"id":"ea889673-af71-41f7-85a0-98f06c0f4725","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/templates/:type","host":["{{baseUrl}}"],"path":["v1","api","messenger","templates",":type"],"variable":[{"key":"type","value":"whatsapp"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"e8c30378-5ee7-4466-b716-5aa3f1ab0f83","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/messenger/templates/:type","host":["{{baseUrl}}"],"path":["v1","api","messenger","templates",":type"],"variable":[{"key":"type","value":"whatsapp"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"597be2da-a93f-49e8-9eae-75a4579faea9"},{"name":"confirmation","id":"876e59b5-864c-4f95-aa61-17952f1e4fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.consultoriome.com/v1/api/appointment/confirm/{{id}}/yes","description":"

Confirm or cancel the appointment by id using the answer yes or no.

confirm/{id}/{yes} - Confirms appointment.

confirm/{id}/{no} - Cancels appointment.

No payload necessary.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","confirm","{{id}}","yes"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"30d7a055-0c9c-480b-a242-860fd9b7ca50","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/confirm/:id/:going","host":["{{baseUrl}}"],"path":["v1","api","appointment","confirm",":id",":going"],"variable":[{"key":"id","value":"string"},{"key":"going","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"id\": \"string\",\n \"going\": \"string\",\n \"message\": \"string\"\n}"},{"id":"96bea2a5-ba9b-478c-a892-f7fe582a152b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/confirm/:id/:going","host":["{{baseUrl}}"],"path":["v1","api","appointment","confirm",":id",":going"],"variable":[{"key":"id","value":"string"},{"key":"going","value":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"c15d72a6-7557-478a-8aa0-84326741fcb1","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/confirm/:id/:going","host":["{{baseUrl}}"],"path":["v1","api","appointment","confirm",":id",":going"],"variable":[{"key":"id","value":"string"},{"key":"going","value":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"876e59b5-864c-4f95-aa61-17952f1e4fc8"},{"name":"patient-appointments","id":"38e815dd-7eed-4486-aeec-0a40e68d4710","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"Phone\": \"(11) 97100-6053\",\r\n \"Document\": \"000.000.000-00\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.consultoriome.com/v1/api/appointment/patient-list","description":"

List the patient next appointments.

Payload using Phone and Document are required.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","patient-list"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"b82fdade-ebf1-4f65-98da-589c785b1f56","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"Phone\": \"string\",\n \"Document\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/v1/api/appointment/patient-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"string\",\n \"DateTime\": \"1987-06-30T07:33:17.957Z\",\n \"Status\": \"string\",\n \"StatusId\": \"string\"\n },\n {\n \"Id\": \"string\",\n \"DateTime\": \"1958-09-18T12:49:31.968Z\",\n \"Status\": \"string\",\n \"StatusId\": \"string\"\n }\n]"},{"id":"0d9aa28a-3c09-4a60-8df9-30b3ff1ba2f2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"Phone\": \"string\",\n \"Document\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v1/api/appointment/patient-list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"dca78cff-4943-4aaf-99ea-e4384c41335b","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"Phone\": \"string\",\n \"Document\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v1/api/appointment/patient-list"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"38e815dd-7eed-4486-aeec-0a40e68d4710"},{"name":"available-times","id":"1e12dd20-f9fa-4e8e-a9ac-ec320a7f19b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/appointment/available-times/{{proid}}","description":"

List all the available appointment times for a professional.

Use the endpoint /professsionals to obtain the {{proid}} value.

Important: To use this feature you must enable the Auto Scheduling feature for each professional in settings.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","available-times","{{proid}}"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"daf3d19c-04b2-4d00-9094-1f7b989deb36","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/available-times/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","available-times",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Slots\": [\n {\n \"TimeSlotId\": \"string\",\n \"DateTime\": \"2023-04-18T18:59:53.677Z\"\n },\n {\n \"TimeSlotId\": \"string\",\n \"DateTime\": \"1991-02-09T19:43:11.589Z\"\n }\n ],\n \"Language\": \"string\",\n \"Country\": \"string\",\n \"Id\": \"string\",\n \"ProId\": \"string\",\n \"TimeZone\": \"string\"\n}"},{"id":"d63d5dc3-ff8d-47c0-89ce-c68235183afc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/available-times/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","available-times",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"fa11e39c-ea23-4842-94f5-ecf97eba0c5b","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/available-times/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","available-times",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"1e12dd20-f9fa-4e8e-a9ac-ec320a7f19b3"},{"name":"professionals","id":"26a850d4-4597-4dd7-b76b-52dcdc089fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/appointment/professionals/","description":"

Lists all the professionals from a clinic.

Use the obtained {{proid}} to list the available times of a professional.

Id and ProId are the same thing and should generate equal values.

Important: To use this feature you must enable the Auto Scheduling feature for each professional in settings.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","professionals",""],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"9469f132-21e6-4d5d-b4fd-8c8b6025a510","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/appointment/professionals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ProId\": \"string\",\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"ExtraInfo\": \"string\",\n \"Info\": \"string\",\n \"Speciality\": \"string\",\n \"GroupSpeciality\": \"string\"\n },\n {\n \"ProId\": \"string\",\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"ExtraInfo\": \"string\",\n \"Info\": \"string\",\n \"Speciality\": \"string\",\n \"GroupSpeciality\": \"string\"\n }\n]"},{"id":"2291382f-18a0-4daf-bd97-eb550843afdc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/appointment/professionals"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"4f6ebed1-8750-4d70-82f9-d8f068c1f0f6","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":"{{baseUrl}}/v1/api/appointment/professionals"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"26a850d4-4597-4dd7-b76b-52dcdc089fc6"},{"name":"professionals-info","id":"747113e1-f829-40fe-9454-12a19b037e6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.consultoriome.com/v1/api/appointment/professional-info/{{proid}}","description":"

Lists all the professional's information, such as opening hours, payment methods, services offered, post-scheduling instructions.

Id and ProId are the same thing and should generate equal values.

Important: To use this feature you must enable the Auto Scheduling feature for each professional in settings.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","professional-info","{{proid}}"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"be016f71-cf5f-4647-bbc2-a999ca4b5b46","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/professional-info/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","professional-info",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ProId\": \"string\",\n \"Id\": \"string\",\n \"Professional\": {\n \"Name\": \"string\",\n \"Document\": \"string\",\n \"ExtraInfo\": \"string\",\n \"AdditionalInfo\": \"string\",\n \"Speciality\": \"string\",\n \"GroupSpeciality\": \"string\"\n },\n \"WebLink\": \"string\",\n \"OpeningHours\": [\n {\n \"DayOfWeek\": \"string\",\n \"Hours\": \"string\"\n },\n {\n \"DayOfWeek\": \"string\",\n \"Hours\": \"string\"\n }\n ],\n \"Language\": \"string\",\n \"Country\": \"string\",\n \"TimeZone\": \"string\",\n \"Address\": {\n \"Address\": \"string\",\n \"Location\": \"string\",\n \"GoogleMapsUrl\": \"string\"\n },\n \"Contact\": {\n \"Facebook\": \"string\",\n \"Instagram\": \"string\",\n \"WhatsApp\": \"string\",\n \"Phone\": \"string\"\n },\n \"Services\": [\n \"string\",\n \"string\"\n ],\n \"AppointmentTypes\": [\n \"string\",\n \"string\"\n ],\n \"PaymentInstructions\": \"string\",\n \"HealthInsuranceInfo\": \"string\",\n \"About\": \"string\",\n \"CompletedMessage\": \"string\"\n}"},{"id":"e0acde79-199e-46af-aaf3-fd80e45eab29","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/professional-info/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","professional-info",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"934ab41b-691b-46d5-a491-45a84325ce67","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/professional-info/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","professional-info",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"747113e1-f829-40fe-9454-12a19b037e6e"},{"name":"create-appointment","id":"bf570067-415c-4a1e-a520-8b5f30cec451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \r\n \"ProId\": \"ctjhccsvvxxckzjqgcnkqvpcdqdhkcmggkbhbm\",\r\n \"DateTime\": \"2024-03-06T12:00:00\",\r\n \"Name\": \"Maria Plaza\",\r\n \"Phone1\": \"31231214512\",\r\n \"Phone2\": \"99999999999\",\r\n \"Document\": \"My A A\",\r\n \"TimeSlotId\": 1821627550800,\r\n \"AppointmentType\": \"Pack 94 (any text)\",\r\n \"BirthDate\": \"1990-05-30\",\r\n \"Email\": \"patientemail@server.com\",\r\n \"ResponsibleName\": \"Alex Plaza\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.consultoriome.com/v1/api/appointment/create-appointment","description":"

Creates an appointment request for the patient.

The appointment will be pending confirmation by the professional/clinic.

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","create-appointment"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"00d796a7-cb63-454d-87e5-32416b1e50cf","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"ProId\": \"string\",\n \"DateTime\": \"1957-04-19T20:42:48.762Z\",\n \"TimeSlotId\": 2261.002071005047,\n \"BirthDate\": \"1984-12-15T06:22:00.923Z\",\n \"Name\": \"string\",\n \"Phone1\": \"string\",\n \"Phone2\": \"string\",\n \"Email\": \"string\",\n \"Document\": \"string\",\n \"ResponsibleName\": \"string\",\n \"AppointmentType\": \"string\",\n \"Observation\": \"string\",\n \"ValidationMessage\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/v1/api/appointment/create-appointment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": true,\n \"Id\": \"string\",\n \"Message\": \"string\"\n}"},{"id":"2e1fbf96-3540-424d-80dd-a9f2affed89e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"ProId\": \"string\",\n \"DateTime\": \"1957-04-19T20:42:48.762Z\",\n \"TimeSlotId\": 2261.002071005047,\n \"BirthDate\": \"1984-12-15T06:22:00.923Z\",\n \"Name\": \"string\",\n \"Phone1\": \"string\",\n \"Phone2\": \"string\",\n \"Email\": \"string\",\n \"Document\": \"string\",\n \"ResponsibleName\": \"string\",\n \"AppointmentType\": \"string\",\n \"Observation\": \"string\",\n \"ValidationMessage\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v1/api/appointment/create-appointment"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"1705c083-0e98-4ee2-9a50-4ec43083c568","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"body":{"mode":"raw","raw":"{\n \"ProId\": \"string\",\n \"DateTime\": \"1957-04-19T20:42:48.762Z\",\n \"TimeSlotId\": 2261.002071005047,\n \"BirthDate\": \"1984-12-15T06:22:00.923Z\",\n \"Name\": \"string\",\n \"Phone1\": \"string\",\n \"Phone2\": \"string\",\n \"Email\": \"string\",\n \"Document\": \"string\",\n \"ResponsibleName\": \"string\",\n \"AppointmentType\": \"string\",\n \"Observation\": \"string\",\n \"ValidationMessage\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v1/api/appointment/create-appointment"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"bf570067-415c-4a1e-a520-8b5f30cec451"},{"name":"cancel-appointment","id":"aded856b-8292-420c-9b35-28ea0920b599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":" ","options":{"raw":{"language":"json"}}},"url":"https://api.consultoriome.com/v1/api/appointment/cancel-appointment/{{id}}","description":"

Cancels the appointment by ID

No payload is necessary

\n","urlObject":{"protocol":"https","path":["v1","api","appointment","cancel-appointment","{{id}}"],"host":["api","consultoriome","com"],"query":[],"variable":[]}},"response":[{"id":"2645f222-5113-4fe7-b0fc-7877e99e6a1e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"/v1/api/appointment/cancel-appointment/:id","path":["v1","api","appointment","cancel-appointment",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"id\": \"string\",\n \"going\": \"string\",\n \"message\": \"string\"\n}"},{"id":"a3808d74-db76-477f-8d08-1346d7e51a95","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/cancel-appointment/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","cancel-appointment",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"},{"id":"4398d25d-ffba-4e72-b19c-4d5c1fc7cf95","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Basic ","description":"Added as a part of security scheme: basic"}],"url":{"raw":"{{baseUrl}}/v1/api/appointment/cancel-appointment/:id","host":["{{baseUrl}}"],"path":["v1","api","appointment","cancel-appointment",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7305,\n \"detail\": \"string\",\n \"instance\": \"string\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}"}],"_postman_id":"aded856b-8292-420c-9b35-28ea0920b599"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"51805434-9d7c-4a7a-b728-c91a057c9e10","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"e15d4664-dd36-44ce-be48-41010af3723d","type":"text/javascript","requests":{},"exec":[""]}}]}