---
title: "Retrieve course assignment information by external id"
slug: "retrieve-course-assignment-information-by-external-id"
updated: 2024-10-25T18:04:27Z
published: 2026-02-10T22:32:35Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skillable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve course assignment information by external id

Get/GetCourseAssignmentByExternalId/{id}

Allows you to get information about a course assignment by providing a unique identifier from your external system.

SecurityAPI Key: api_keyHeader parameter nameapi_key

Path parametersidstringRequired

The external ID of the course assignment to retrieve

Responses200

OK Response

<select class='api-response-data' aria-label='Media type'><option value='11dd31b1-65b1-4c1c-965f-e66780707dee'>application/json</option>
</select>Expand Allobject  Statusinteger  (int32)    

Indicates the status of the API request.

0 = Success 10 = Error 20 = Not found 30 = Invalid integration key

Example10
Errorstring   | null  

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Results Array of object (CourseAssignment)   

See CourseAssignment

object  Idinteger  (int32)    

The course assignment's unique identifier

Example1234
ExternalIdstring   | null  

The course assignment's external ID, usually a unique identifier from the calling system

ExampleC9876ZFGEFER9876
CourseIdinteger  (int32)    

The Id of the course associated with this course assignment.

Example123
UserIdinteger  (int32)    

The UserId of the user that is associated with this course assignment.

Example3434
ClubMembershipIdinteger  (int32)   | null  

The subscription (if any) associated with this course assignment.

Example119955
Expireinteger  (int64)   | null  

When the course assignment expires (if ever) (in Unix epoch time)

Example1450479600
TargetCompletioninteger  (int64)   | null  

When course assignment is expected to be completed by the student (in Unix epoch time)

Example1449496800
Startinteger  (int64)   | null  

When the course assignment was started (if ever) (in Unix epoch time)

Example1449496800
Completeinteger  (int64)   | null  

When the course assignment was completed (if ever) (in Unix epoch time)
