ManagementEvents

Gets management events for a specific inventory item

Retrieves a paginated list of management events for a specific inventory item for a given AgencyRef and all permissible branches.

get/inventory/{inventoryId}/management-events

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/inventory/{inventoryId}/management-events
  • Auth: appAuth (a scheme the document does not define)

Path parameters

inventoryIdinteger required

ID of the inventory item

Query parameters

createdFromstring date-time

The start date for filtering management events by created date.

createdTostring date-time

The end date for filtering management events by created date.

modifiedFromstring date-time

The start date for filtering management events by modified date.

modifiedTostring date-time

The end date for filtering management events by modified date.

nextTokenstring

Token used to retrieve the next page of results. This is returned in the response of the previous page.

maxResultsinteger

Maximum number of results to return per page. Defaults to 100 if not specified.

upcomingboolean

When true, filters events to show only those that are either overdue or due within the period defined by their reminderDays field from today's date

statusstring[]

List of event statuses to filter by. If not provided, events of all statuses will be returned.

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.