> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: df94b049-b4b2-4a0f-bf0f-072d67b06b20
---
# Retrieve a course
> Read an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-03/crm-courses-v2026-03.json GET /crm/objects/2026-03/0-410/{courseId}
openapi: 3.0.1
info:
title: Courses
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-introduction: >-
Use the courses API to create and manage CRM records that represent
information about a structured program or series of lessons, trainings, or
educational modules. Identify the course object type with its object type ID
0-410
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
- name: Search
paths:
/crm/objects/2026-03/0-410/{courseId}:
get:
tags:
- Basic
summary: Retrieve a course
description: >-
Read an Object identified by `{courseId}`. `{courseId}` refers to the
internal object ID by default, or optionally any unique property value
as specified by the `idProperty` query param. Control what is returned
via the `properties` query param.
operationId: get-/crm/objects/2026-03/0-410/{courseId}
parameters:
- name: courseId
in: path
required: true
schema:
pattern: .+
type: string
- name: archived
in: query
description: Whether to return only results that have been archived.
required: false
style: form
explode: true
schema:
type: boolean
default: false
- name: associations
in: query
description: >-
A comma separated list of object types to retrieve associated IDs
for. If any of the specified associations do not exist, they will be
ignored.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: idProperty
in: query
description: The name of a property whose values are unique for this object type
required: false
style: form
explode: true
schema:
type: string
- name: properties
in: query
description: >-
A comma separated list of the properties to be returned in the
response. If any of the specified properties are not present on the
requested object(s), they will be ignored.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: propertiesWithHistory
in: query
description: >-
A comma separated list of the properties to be returned along with
their history of previous values. If any of the specified properties
are not present on the requested object(s), they will be ignored.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/SimplePublicObjectWithAssociations'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- crm.objects.courses.read
components:
schemas:
SimplePublicObjectWithAssociations:
required:
- archived
- createdAt
- id
- properties
- updatedAt
type: object
properties:
archived:
type: boolean
description: A boolean indicating whether this object is archived.
archivedAt:
type: string
description: The date and time when this object was archived, in ISO 8601 format.
format: date-time
associations:
type: object
additionalProperties:
$ref: '#/components/schemas/CollectionResponseAssociatedId'
description: >-
A map of associated object types to their associated IDs,
represented as collections of associated IDs.
createdAt:
type: string
description: The date and time when this object was created, in ISO 8601 format.
format: date-time
id:
type: string
description: The unique identifier for this object.
objectWriteTraceId:
type: string
description: >-
A string identifier used to trace the write operations for this
object.
properties:
type: object
additionalProperties:
type: string
description: A map of property names to their current values for this object.
propertiesWithHistory:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ValueWithTimestamp'
description: >-
A map of property names to their values, including a history of
changes, represented as arrays of values with timestamps.
updatedAt:
type: string
description: >-
The date and time when this object was last updated, in ISO 8601
format.
format: date-time
url:
type: string
description: The URL link to access this object.
warnings:
type: array
description: >-
An array of warnings associated with this object, each containing a
category, message, and context.
items:
$ref: '#/components/schemas/PublicObjectWarning'
description: >-
Represents a CRM object along with its properties, timestamps, and a set
of associated object IDs grouped by association type.
CollectionResponseAssociatedId:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
description: >-
An array of associated IDs, each represented by an AssociatedId
object.
items:
$ref: '#/components/schemas/AssociatedId'
ValueWithTimestamp:
required:
- sourceType
- timestamp
- value
type: object
properties:
sourceId:
type: string
description: A string representing the unique identifier of the source.
sourceLabel:
type: string
description: A string providing a label or description for the source.
sourceType:
type: string
description: >-
A string indicating the type of source from which the value
originated.
timestamp:
type: string
description: The date and time when the value was recorded, in ISO 8601 format.
format: date-time
updatedByUserId:
type: integer
description: >-
An integer representing the ID of the user who last updated the
value.
format: int32
value:
type: string
description: A string representing the data value.
description: Property model that includes timestamp.
PublicObjectWarning:
required:
- category
- context
- message
type: object
properties:
category:
type: string
description: A string representing the category of the warning.
context:
type: object
additionalProperties:
type: string
description: >-
An object providing additional context for the warning, with string
properties.
message:
type: string
description: A string containing the warning message.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category, providing a general classification of the error.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object with
additional properties that are arrays of strings.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets. Format: UUID.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
Further information about the error, provided as an array of
ErrorDetail objects.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error.
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
AssociatedId:
required:
- id
- type
type: object
properties:
id:
type: string
description: >-
The unique identifier for the associated object, represented as a
string.
type:
type: string
description: >-
The type of association, represented as a string, indicating the
nature of the relationship between objects.
example: deal_to_contact
description: Contains the id and type of an association
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: >-
The status code associated with the error detail. This is a string
property.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object with
additional properties that are arrays of strings.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found.
This is a string property.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required string property.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error. This is a string property.
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: A string token used as a cursor to fetch the next page of results.
link:
type: string
description: >-
A string URL that provides a direct link to the next page of
results.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
PreviousPage:
required:
- before
type: object
properties:
before:
type: string
description: >-
A string token used to identify the position of the previous page in
the pagination sequence.
link:
type: string
description: >-
A string URL that provides a direct link to access the previous page
of results.
description: >-
specifies the paging information needed to retrieve the previous set of
results in a paginated API response
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
crm.objects.commercepayments.read: ''
crm.objects.courses.read: ''
crm.objects.courses.write: ''
oauth: ''
````
{product.name} -
{product.level}
)}