---
updatedAt: 2025-09-22T21:35:01.000Z
agentTools:
  projectIndex: https://developers.digitalfemsa.io/llms.txt
---

# Get list of Events

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "engineering@femsa.com",
      "name": "Engineering Femsa",
      "url": "https://github.com/digitalfemsa/openapi/issues"
    },
    "description": "Femsa sdk",
    "license": {
      "name": "MIT-LICENSE",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Femsa API",
    "version": "2.1.0"
  },
  "servers": [
    {
      "description": "Femsa main server",
      "url": "https://api.digitalfemsa.io"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/events": {
      "get": {
        "operationId": "getEvents",
        "parameters": [
          {
            "description": "Use for knowing which language to use",
            "examples": {
              "es": {
                "summary": "for spanish request/response",
                "value": "es"
              },
              "en": {
                "summary": "for english request/response",
                "value": "en"
              }
            },
            "in": "header",
            "name": "Accept-Language",
            "required": false,
            "schema": {
              "default": "es",
              "enum": [
                "es",
                "en"
              ],
              "type": "string"
            }
          },
          {
            "description": "In the case of a holding company, the company id of the child company to which will process the request.",
            "example": "6441b6376b60c3a638da80af",
            "in": "header",
            "name": "X-Child-Company-Id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The numbers of items to return, the maximum value is 250",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 20,
              "format": "int32",
              "maximum": 250,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "General order search, e.g. by mail, reference etc.",
            "in": "query",
            "name": "search",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "next page",
            "in": "query",
            "name": "next",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "previous page",
            "in": "query",
            "name": "previous",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/get_events_response"
                }
              }
            },
            "description": "successful"
          },
          "401": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "Please include your access key in your request.",
                      "param": null,
                      "code": "femsa.errors.authentication.missing_key"
                    }
                  ],
                  "log_id": "507f1f77bcf86cd799439011",
                  "object": "error",
                  "type": "authentication_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "authentication error"
          },
          "500": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "debug_message": "There was a runtime error and Femsa engineers have been notified.",
                      "message": "There was a runtime error and Femsa engineers have been notified.",
                      "param": null,
                      "code": "femsa.errors.api.system.general_failure"
                    }
                  ],
                  "object": "error",
                  "type": "api_error",
                  "log_id": "641b6f2b3cd9a50001515098"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get list of Events",
        "tags": [
          "Events"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "page": {
        "description": "page metadata",
        "properties": {
          "next_page_url": {
            "description": "URL of the next page.",
            "example": "https://api.femsa.io/resources?limit=10&next=chrg_1",
            "nullable": true,
            "type": "string"
          },
          "previous_page_url": {
            "description": "Url of the previous page.",
            "example": "https://api.femsa.io/resources?limit=10&previous=chrg_1",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "page metadata",
        "type": "object"
      },
      "pagination": {
        "description": "pagination metadata",
        "properties": {
          "has_more": {
            "description": "Indicates if there are more pages to be requested",
            "example": false,
            "type": "boolean"
          },
          "object": {
            "description": "Object type, in this case is list",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "has_more",
          "object"
        ],
        "title": "pagination metadata",
        "type": "object"
      },
      "error": {
        "allOf": [
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "properties": {
              "log_id": {
                "description": "log id",
                "example": "507f1f77bcf86cd799439011",
                "nullable": true,
                "type": "string"
              },
              "type": {
                "example": "authentication_error",
                "type": "string"
              },
              "object": {
                "example": "error",
                "type": "string"
              }
            },
            "type": "object"
          }
        ],
        "description": "err model",
        "title": "error"
      },
      "event_response": {
        "description": "event model",
        "properties": {
          "created_at": {
            "example": 1661445644,
            "format": "int64",
            "type": "integer"
          },
          "data": {
            "additionalProperties": true,
            "example": {
              "action": "ping",
              "livemode": true
            },
            "maxProperties": 100,
            "type": "object"
          },
          "id": {
            "example": "6307a60c41de27127515a575",
            "type": "string"
          },
          "livemode": {
            "example": true,
            "type": "boolean"
          },
          "object": {
            "example": "event",
            "type": "string"
          },
          "type": {
            "example": "webhook_ping",
            "type": "string"
          },
          "webhook_logs": {
            "items": {
              "$ref": "#/components/schemas/WebhookLog"
            },
            "type": "array"
          },
          "webhook_status": {
            "example": "successful",
            "type": "string"
          }
        },
        "title": "event_response",
        "type": "object"
      },
      "details": {
        "properties": {
          "details": {
            "items": {
              "$ref": "#/components/schemas/details_error"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "get_events_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/pagination"
          },
          {
            "$ref": "#/components/schemas/page"
          },
          {
            "properties": {
              "data": {
                "items": {
                  "$ref": "#/components/schemas/event_response"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        ],
        "title": "get_events_response"
      },
      "WebhookLog": {
        "properties": {
          "failed_attempts": {
            "example": 10,
            "type": "integer"
          },
          "id": {
            "example": "webhl_2svd2sh6GbqzyWBNZ",
            "type": "string"
          },
          "last_attempted_at": {
            "example": 1669651274,
            "type": "integer"
          },
          "last_http_response_status": {
            "example": 200,
            "format": "int32",
            "type": "integer"
          },
          "object": {
            "example": "webhook_log",
            "type": "string"
          },
          "response_data": {
            "additionalProperties": true,
            "example": {
              "amount": 3000,
              "payable": true
            },
            "maxProperties": 100,
            "type": "object"
          },
          "url": {
            "example": "https://username:password@mockoon.stg.femsa.io/payments-api/cash/merchant_approval",
            "format": "uri",
            "type": "string"
          }
        },
        "title": "WebhookLog",
        "type": "object"
      },
      "details_error": {
        "properties": {
          "code": {
            "example": "femsa.errors.authentication.missing_key",
            "type": "string"
          },
          "param": {
            "nullable": true,
            "type": "string"
          },
          "message": {
            "example": "Acceso no autorizado.",
            "type": "string"
          },
          "debug_message": {
            "example": "Please include your access key in your request.",
            "type": "string"
          }
        },
        "title": "details_error",
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```