List all patients for an expert

Returns a paginated list of patients. Page size is fixed at 50 patients.

Requires the patients:read permission.

GET/patients

Autorización

AuthorizationToken Bearer (API Key) · headerobligatorio

Almendra API key, bound to one professional account. Send it as Authorization: Bearer YOUR_API_KEY.

Ámbitos:patients:read

Parámetros de consulta

pageinteger

Page number (starts at 1)

mín. 0 · predeterminado: 1

searchstring

Patients whose first name, last name or email starts a word with this (accents ignored)

longitud mín. 2 · longitud máx. 70

Respuestas

200

List of patients

patientsPatientResponse[]obligatorio

Mostrar propiedades

Array de PatientResponse

_idstringobligatorio

firstNamestringobligatorio

lastNamestringobligatorio

emailstring<email>

phonestring

nationalitystring

addressobject[]

Mostrar propiedades

Array de object

valuestringobligatorio

timestampstring<date-time>obligatorio

birthdatestring<date-time>

idNumberstring

occupationstring

sexstringobligatorio

Valores permitidos:malefemaleother

expertstringobligatorio

createdAtstring<date-time>obligatorio

updatedAtstring<date-time>obligatorio

pageintegerobligatorio

mín. 0

pageSizeintegerobligatorio

mín. 0

totalCountintegerobligatorio

totalPagesintegerobligatorio

400

Invalid path parameter, query parameter or request body

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

Valores permitidos:bad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictpayload_too_largeunsupported_media_typeunprocessable_entityrate_limitedinternal_errornot_implementedbad_gatewayservice_unavailablegateway_timeout

messagestringobligatorio

Human-readable explanation of what went wrong.

401

Unauthorized - Invalid API key

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

403

The account behind the API key has no active paid plan, or the key lacks the permission this operation needs

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

404

Expert not found

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

429

Rate limit exceeded (600 requests per 60 seconds); retry after Retry-After seconds

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

500

Unexpected server error

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

Pruébalo

Servidor

URL baseURL base personalizadaSi se define, sustituye al servidor seleccionado.

Autorización

Token Bearer (API Key)Recordar en este dispositivoIncluir mis valores en los ejemplos

Parámetros

pagequeryPage number (starts at 1)searchqueryPatients whose first name, last name or email starts a word with this (accents ignored)

Solicitud

curl -X GET 'https://api.almendra.io/openapi/v1/patients' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response: Response = await fetch("https://api.almendra.io/openapi/v1/patients", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://api.almendra.io/openapi/v1/patients",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.almendra.io/openapi/v1/patients",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Respuesta

{
  "patients": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "nationality": "American",
      "address": [
        {
          "value": "123 Main St, City, State 12345",
          "timestamp": "2024-01-15T00:00:00.000Z"
        }
      ],
      "birthdate": "1990-01-15T00:00:00.000Z",
      "idNumber": "123456789",
      "occupation": "Software Engineer",
      "sex": "male",
      "expert": "507f1f77bcf86cd799439012",
      "createdAt": "2024-01-15T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 150,
  "totalPages": 3
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

List all patients for an expert

¿No encuentras lo que buscas?