Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Event → Get List

AI-generated

Summary

Retrieve a filtered list of Event records from the Acumatica API endpoint.

Inputs

  • All Day Filter — Filter events by whether they are all-day events. Supports the 'Equals' operator with a boolean value.
  • Body Filter — Filter events by their body text. Supports operators: Equals, Contains, and Starts With with string values.
  • Category Filter — Filter events by category with operators: Equals, Contains, and Starts With (string).
  • End Date Time Filter — Filter events by their end date and time with operators: Equals, After, On or After, Before, On or Before (dateTime).
  • Internal Filter — Filter events based on internal flag. Supports 'Equals' operator with boolean value.
  • Location Filter — Filter events by location using operators: Equals, Contains, Starts With (string).
  • Priority Filter — Filter events by priority with operators: Equals, Contains, Starts With (string).
  • Show As Filter — Filter events by their Show As status, supporting Equals, Contains, Starts With (string).
  • Start Date Filter — Filter events by start date with operators: Equals, After, On or After, Before, On or Before (dateTime).
  • Status Filter — Filter events by status with operators: Equals, Contains, Starts With (string).
  • Summary Filter — Filter events by summary text with operators: Equals, Contains, Starts With (string).
  • Created By ID Filter — Filter events by the ID of the creator, supporting Equals, Contains, Starts With (string).
  • Created Date Time Filter — Filter events by creation date time with operators: Equals, After, On or After, Before, On or Before (dateTime).
  • Last Modified Date Time Filter — Filter events by last modified date time with operators: Equals, After, On or After, Before, On or Before (dateTime).
  • Related Entity Type Filter — Filter events by related entity type using operators: Equals, Contains, Starts With (string).
  • Related Entity Description Filter — Filter events by related entity description supporting Equals, Contains, Starts With (string).
  • Custom Filter — Apply an advanced OData $filter expression to further filter results (e.g., "CustomerID/value eq 'CUST001'"). This filter is applied in addition to any of the above filters.

Output shape

a list of Event records matching the specified filters

Filters are combined into an OData $filter query for the Acumatica API. If no filters are set, all events are returned. The returned list structure follows the Acumatica API's Event entity schema.

Examples

Example 1: Retrieve all events starting on or after a specified date

Set the Start Date Filter with operator 'On or After' and the desired date-time value.

Example 2: Find events whose summary contains a keyword

Set the Summary Filter with operator 'Contains' and specify the keyword.

Example 3: Get internal, all-day events in a specific category

Set Internal Filter to true, All Day Filter to true, and Category Filter with the desired category value.

Links

Discussion