v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

Completion

Get All Completions

This endpoint retrieves all completions for the organization. To retrieve results, you must use either both added filters, or both completed filters. The filters require a start and end date, with a maximum range of 7 days.<br><br>For Global Admin Tool Organizations, if the X-Degreed-Organization-Code header is included, the endpoint will return completions for the Tenant Organization related to the header value as long as the organization is a member of the Global Admin Tool Organization. <h3>Required Scope</h3>completions:read or completions:write

get/api/v2/completions

Query parameters

filter[added_after]string date

Filter criteria that returns completions added after this date. This field represents the system generated completion date. Format yyyy-mm-dd.

filter[added_before]string date

Filter criteria that returns completions added before this date. This field represents the system generated completion date. Format yyyy-mm-dd.

filter[completed_after]string date

Filter criteria that returns completions completed after this date. This field represents the user entered or integration populated date. Format yyyy-mm-dd.

filter[completed_before]string date

Filter criteria that returns completions completed before this date. This field represents the user entered or integration populated date. Format yyyy-mm-dd.

filter[content_id]string

Filter criteria that only returns content with this ID.

filter[content_type]string

Filter criteria that only returns content with this content type. Acceptable values are course, event, video, assessment, podcast, book, or task.

nextstring

Retrieves the next batch of completions. This value expires after 2 minutes if a request has not been made during that time.

limitinteger

The maximum number of completions to display per page. A maximum of 1000 is allowed.

Headers

X-Degreed-Organization-Codestring

Example:tenant_organization_code

For Global Admin Tool Organizations, include this header in your request to retrieve completions from the tenant organization. You must provide your organization code as the value. Contact your Degreed technical partner if you are unsure what your organization code is.

Response

Success