Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Appointment → Get List

AI-generated

Summary

Get list of Appointment records from Acumatica with filtering.

Inputs

  • Filter fields — One fixedCollection per filterable Appointment property (e.g., ActualDurationFilter, ActualEndDateFilter, CustomerFilter, etc.). Each contains an operator (eq, contains, startswith for strings; eq, gt, ge, lt, le for dates/numbers; eq for booleans) and a value. Empty values are ignored.
  • customFilter — Advanced OData $filter string (e.g., 'CustomerID/value eq ''CUST001''') that is combined with the other filters.

Output shape

array

Array of Appointment objects matching the combined filter expression.

Examples

Example 1: Find appointments for a specific customer after a date

Set CustomerFilter operator = eq, value = 'CUST001'; set ActualStartDateFilter operator = gt, value = '2024-01-01T00:00:00'

Example 2: Retrieve all appointments with a custom OData filter

Leave all filter fields empty, set customFilter = 'contains(Description/value, ''visit'')'

Links

Discussion