WorkOS

events.list

List events for the current environment.

Remote workos

Other tools also called events.list? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "after": {
      "type": "string",
      "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `after=\"obj_123\"` to fetch a new batch of objects after `\"obj_123\"`."
    },
    "limit": {
      "type": "integer",
      "default": 10,
      "description": "Upper limit on the number of objects to return, between `1` and `100`."
    },
    "order": {
      "enum": [
        "normal",
        "desc",
        "asc"
      ],
      "type": "string",
      "default": "desc",
      "description": "Order the results by the creation time. Supported values are `\"asc\"` (ascending), `\"desc\"` (descending), and `\"normal\"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending."
    },
    "before": {
      "type": "string",
      "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `before=\"obj_123\"` to fetch a new batch of objects before `\"obj_123\"`."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter events by one or more event types (e.g. `dsync.user.created`)."
    },
    "range_end": {
      "type": "string",
      "description": "ISO-8601 date string to filter events created before this date."
    },
    "range_start": {
      "type": "string",
      "description": "ISO-8601 date string to filter events created after this date."
    },
    "organization_id": {
      "type": "string",
      "description": "Filter events by the [Organization](/reference/organization) that the event is associated with."
    }
  }
}
          

Provider

WorkOS →