v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

User

Get Completions for a Specific User

This endpoint retrieves all completions for a specific user. You can retrieve a user by specifying the ID as a path parameter or specifying an identifier as a query string URL parameter. For example, https://api.betatest.degreed.com/api/v2/users/<email_value>/completions?identifier=email<br><br>For Global Admin Tool Organizations, if the user belongs to a Tenant Organization, then the X-Degreed-Organization-Code header must be provided.<h3>Required Scope</h3>users:read, users:write, completions:read or completions:write

get/api/v2/users/{id}/completions

Path parameters

idstring required

The ID of the user to retrieve.

Query parameters

limitinteger

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

identifierstring

How to identify the user. The identifier can be id (default), employee-id, or email and must be used as a query string URL parameter. For example, https://api.betatest.degreed.com/api/v2/users/<email_value>/completions?identifier=email

filter[added_after]string date required

Filter criteria that returns completions added after this date. Format yyyy-mm-dd.

filter[added_before]string date required

Filter criteria that returns completions added before this date. Format yyyy-mm-dd.

filter[content_id]integer

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.

Headers

X-Degreed-Organization-Codestring

Example:tenant_organization_code

For Global Admin Tool Organizations, include this header in your request to retrieve completions for the specified user in 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