External Credits API

LIST

Resource: /api/v2/external_credits

HTTPS Request Method: GET

Description: Get the list of all external credits associated with the account.

External Credits list results are limited to 40,000 records and can be paginated.

Required Parameters:

• api_key

Optional Parameters:

• fields - this consists of a list separated by commas of the external credit fields that you wish to retrieve. If not present, all fields are included. page - the page you want to request. Every page is 40,000 records long at most. If not present, page 1 is assumed.
• external_credit[id] - (integer)
• external_credit[user_id] - (integer)
• external_credit[name] - (string)
• external_credit[instructor] - (string)
• external_credit[location] - (string)
• external_credit[expires_on] - (datetime)
• external_credit[is_protected] - (boolean)
• external_credit[created_at] - (datetime)
• external_credit[updated_at] - (datetime)

Dates and datetimes should be in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format and can be given as ranges if separated by a comma.

Example Request:

curl -X GET -d '{"api_key": "123456", "fields": "name,code", "external_credit": {"instructor": "Joe Doe"}}' -H "Content-type: application/json" -H "Accept: application/json" https://YOURSUBDOMAIN.exceedlms.com/api/v2/external_credits

Example Response

[
  {
    "name": "Strategies for Reducing Technical Debt",
    "code": "Regulatory"
  },
  {
    "name": "Ethical Communication for Written Documents",
    "code": "Webinar"
  },
  {
    "name": "Hiring Overseas Contractors",
    "code": "Legal"
  }
]