> ## Documentation Index > Fetch the complete documentation index at: https://docs.brelio.com/llms.txt > Use this file to discover all available pages before exploring further. # Agenda > Reads the clinic's agenda: the appointments in a time window, with start and end, status, professional, service, patient and center. **When to use it:** To see which appointments fall on a day or week, or a professional's or center's. At most 31 days per call; it returns no notes or names. ## OpenAPI ````yaml /api-reference/openapi.en.json get /agenda openapi: 3.1.0 info: title: Brelio API version: '1' description: >- Everything a person can do in Brelio, a program can do, with the same permissions, audit and limits. Every endpoint is derived from the operation catalogue. servers: - url: https://api.brelio.app/v1 security: [] paths: /agenda: get: tags: - calendar summary: Agenda description: >- Reads the clinic's agenda: the appointments in a time window, with start and end, status, professional, service, patient and center. **When to use it:** To see which appointments fall on a day or week, or a professional's or center's. At most 31 days per call; it returns no notes or names. operationId: agenda.list parameters: - name: cursor in: query required: false schema: type: string maxLength: 200 description: '`next_cursor` of the previous page. Omit it for the first page.' - name: limit in: query required: false schema: default: 25 type: integer minimum: 1 maximum: 100 description: Page size, 1 to 100. - name: from in: query required: true schema: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ description: Start of the window, ISO 8601 (inclusive). - name: to in: query required: true schema: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ description: End of the window, ISO 8601. At most 31 days after `from`. - name: professionalId in: query required: false schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Only this professional’s appointments. - name: centerId in: query required: false schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Only this center’s appointments. responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: Stable id of the appointment occurrence. start: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. end: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. status: type: string enum: - scheduled - checked_in - in_progress - needs_review - completed - cancelled - no_show - voided professionalId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' serviceId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' patientId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: >- The patient, or the first one of a group appointment; null when the caller may not see who it is. centerId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' required: - id - start - end - status - professionalId - serviceId - patientId - centerId additionalProperties: false next_cursor: anyOf: - type: string - type: 'null' description: >- Pass it as `cursor` to read the next page; null on the last page. has_more: type: boolean required: - data - next_cursor - has_more additionalProperties: false '401': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '402': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '422': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '429': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '503': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' security: - bearer: [] components: schemas: Problem: type: object required: - type - title - status - code - detail - request_id - params properties: type: type: string title: type: string status: type: integer code: type: string detail: type: string request_id: type: string hint: type: string retryAfterSeconds: type: integer params: type: object securitySchemes: bearer: type: http scheme: bearer description: Brelio API key (organization or user) or a WorkOS access token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.