openapi: 3.2.0 info: title: Relay External REST Events API version: 1.1.0 description: REST API for programmatic access to Relay CRM resources. servers: - url: https://your-domain.com/api/v1 description: Production security: - bearerAuth: [] tags: - name: Events paths: /events: get: summary: List events tags: - Events parameters: - name: limit in: query description: Max results to return (default 50, max 100). schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: Cursor for pagination (ISO date string). schema: type: string - name: offset in: query description: Optional offset for pagination (not used by all endpoints). schema: type: integer minimum: 0 - name: ticket_id in: query schema: type: string format: uuid - name: customer_id in: query schema: type: string format: uuid - name: type in: query schema: type: string - name: start_date in: query schema: type: string description: YYYY-MM-DD - name: end_date in: query schema: type: string description: YYYY-MM-DD responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Event' meta: $ref: '#/components/schemas/PaginationMeta' required: - data '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' operationId: getEvents x-operation-id-source: derived components: schemas: ErrorResponse: type: object properties: error: type: object properties: code: type: string message: type: string details: {} required: - code - message required: - error PaginationMeta: type: object properties: total: type: integer limit: type: integer next_cursor: type: - string - 'null' Event: type: object properties: id: type: string format: uuid type: type: string created_at: type: string format: date-time additionalProperties: true securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key