Skip to main content
GET
List Workforce Trainings Paginated
← Own Workforce API The paginated training list, and the one to build against. It takes the same filters as the flat list, adds group view and column filters, and returns the filter_hash that Bulk Delete Workforce Trainings by Filters requires.
This endpoint declares no response schema in the OpenAPI document, so generated clients will see an untyped body. The shape below is what it actually returns; the items are the same training objects as List Workforce Trainings.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

integer
default:"1"
Page number, starting at 1
integer
default:"50"
Page size, between 1 and 100
array[string]
Filter by source upload file. The nil UUID matches rows with no file.
datetime
Only rows created at or after this instant
datetime
Only rows created on or before this instant, inclusive
Free-text search, up to 255 characters
boolean
default:"false"
Group view. true widens the list to the header organization’s accepted business family.
array[string]
Restrict a group-view list to these organizations. Only meaningful with consolidate_group=true.
string
Scope to a project’s reporting perimeter, together with scope_to_project_organizations
boolean
default:"false"
Narrow the perimeter to the organizations attached to project_id

Response

array[object]
Training records — see List Workforce Trainings for the fields
integer
Rows matching the filters across all pages
integer
Current page
integer
Current page size
string
Fingerprint of the applied filters, required by bulk delete by filters

Example

Successful Response

Common Errors

401 Unauthorized

Cause: the key is invalid, or it does not belong to the organization in x-organization-id — the two are looked up as a pair. A request carrying no credentials at all answers AUTH_REQUIRED instead.

403 Forbidden

Cause: the key’s owner is not an enabled member of the organization in x-organization-id.

422 Unprocessable Entity

Cause: a malformed parameter, or size above 100.

Trainings unique values

Build the file filter

Bulk delete by filters

Delete exactly what this returned