Actions feed reference

James Lett

Updated 11 August 2026 15:05

The actions feed provides read-only access to all actions created within reviews for learners across all programmes. You can use it to build reports in Excel, Power BI, or custom integrations.

This page covers the fields the feed returns, the query options you can use, and practical examples. For general information about OData v2, see Introduction to OData v2. For a full explanation of how query options work, see How to query OData v2 feeds.

Using the documentation on your tenant

Your tenant hosts interactive API documentation that you can use alongside this guide. Log into your Aptem tenant and navigate to:

URL	What it shows
`/odata/2.0/docs`	Interactive documentation listing all available feeds, their fields, query options, and example responses. This is the best place to explore what the API offers.
`/odata/2.0/$metadata`	The machine-readable OData metadata document (CSDL). Useful if you are building integrations and need the exact data model.
`/odata/2.0/openapi.json`	The OpenAPI specification for the v2 feeds. You can import this into tools such as Postman or Swagger UI to explore and test requests.

The docs page on your tenant will always reflect the feeds and fields available to you. As new feeds are added to OData v2, they will appear there automatically.

Fields

Field	Type	Description
`Id`	UUID	The unique identifier of the action
`Action`	String	The description of the action as shown to the learner
`Status`	String	The current status of the action (see statuses below)
`DueDate`	Date	The date the action is due to be completed. Null if no due date has been set.
`LearnerId`	Integer	The identifier of the learner the action is assigned to. Matches the `Id` field in the Users v1 feed.
`ProgrammeId`	Integer	The identifier of the programme the action belongs to. Matches `ProgramId` in the Reviews v1 feed.
`CreatedDate`	DateTimeOffset	The date and time the action was created
`CreatedBy`	Integer	The identifier of the user who created the action
`UpdatedDate`	DateTimeOffset	The date and time the action was last updated
`ClosedDate`	DateTimeOffset	The date and time the action was closed. Null if the action is still open.
`ClosedBy`	Integer	The identifier of the user who closed the action. Null if the action is still open.

Statuses

The Status field returns one of the following values:

Status	Description
`None`	No status has been set
`Open`	The action is open and awaiting completion
`Completed`	The action has been completed
`NotRequired`	The action has been marked as not required

Querying the feed

The actions feed supports the following query options:

Option	What it does	Example
`$select`	Return only the fields you specify	`$select=Id,Action,Status,DueDate`
`$filter`	Filter results by field values	`$filter=Status eq 'Open'`
`$orderby`	Sort results by a field (add `desc` for descending)	`$orderby=DueDate desc`
`$top`	Return only the first N items	`$top=50`
`$count`	Include the total count of matching items	`$count=true`

You cannot filter or sort by the Action, CreatedBy, or ClosedBy fields. All other fields support filtering and sorting.

For a detailed explanation of each option and how to use them in the browser and Excel, see How to query OData v2 feeds. For ready-made queries you can copy, see OData v2 query examples.

Filter operators

Operator	Meaning	Example
`eq`, `ne`	Equals, not equals	`Status eq 'Open'`
`gt`, `ge`, `lt`, `le`	Greater/less than (or equal)	`DueDate lt 2026-08-01`
`and`, `or`, `not`	Combine clauses	`Status eq 'Open' and DueDate lt 2026-08-01`

Example queries

All open actions, sorted by due date (soonest first):

/odata/2.0/actions?$filter=Status eq 'Open'&$orderby=DueDate

All actions for a specific learner:

/odata/2.0/actions?$filter=LearnerId eq 48213

All overdue open actions (due before today), returning only key fields:

/odata/2.0/actions?$filter=Status eq 'Open' and DueDate lt 2026-07-27&$select=Id,Action,DueDate,LearnerId&$orderby=DueDate

Count of completed actions:

/odata/2.0/actions?$filter=Status eq 'Completed'&$count=true&$top=0

Actions created in the last 30 days:

/odata/2.0/actions?$filter=CreatedDate ge 2026-06-27T00:00:00Z&$orderby=CreatedDate desc

Results are always paged. Each page returns up to 1,000 items. When more items are available, the response includes an @odata.nextLink field containing the URL of the next page.

To read through a full result set, follow the @odata.nextLink until it is no longer present in the response. Do not build your own paging by incrementing $skip, as this can miss or duplicate items if data changes between requests.

If you need smaller pages, send a Prefer header with your request:

Prefer: odata.maxpagesize=100

Linking to v1 feeds

The actions feed can be combined with v1 OData feeds to build richer reports in Excel using Power Queries. The key join fields are:

Actions field	v1 feed	v1 field	What it gives you
`LearnerId`	Users	`Id`	Learner name, programme, case owner, and other learner details
`ProgrammeId`	Reviews	`ProgramId`	Review name, type, status, and completion date (joined with `LearnerId`)
`CreatedBy`	Users	`Id`	Name of the person who created the action
`ClosedBy`	Users	`Id`	Name of the person who closed the action

For step-by-step guides on building combined reports in Excel, see:

Building a reviews and actions report using OData in Excel

Getting help

If you have questions about the actions feed or need your API key:

Contact your Implementation Consultant if you are still in implementation
Contact your Customer Success Manager if you are a live customer
Raise a support ticket