> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/program-gql.md).

# Program Gql

No description

```graphql
type ProgramGQL {
  id: String!
  name: String!
  publicName: String
  customerId: String
  description: String
  publishStatus: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  owner: String!
  startDate: DateTime
  endDate: DateTime
  variant: ProgramVariantType!
  courseCompletionCount: Int
  courseEnrollment: CourseEnrollmentType!
  canvasAccountId: String
  canvasAccountName: String
  requirements: [ProgramRequirementGQL!]!
  enrollments: [ProgramEnrollmentGQL!]!
  progresses: [ProgramProgressGQL!]!
  uniqueSkills: Float!
  skills: [SkillTaxonomySkillGQL!]!
}
```

#### Fields

[**`ProgramGQL`.`id`**](#id) **●** [**`String!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

[**`ProgramGQL`.`name`**](#name) **●** [**`String!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

Internal name of the program

[**`ProgramGQL`.`publicName`**](#public-name) **●** [**`String`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

Public-facing name of the program

[**`ProgramGQL`.`customerId`**](#customer-id) **●** [**`String`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

Custom ID associated by the creator

[**`ProgramGQL`.`description`**](#description) **●** [**`String`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

[**`ProgramGQL`.`publishStatus`**](#publish-status) **●** [**`String!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

[**`ProgramGQL`.`createdAt`**](#created-at) **●** [**`DateTime!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/date-time.md)

[**`ProgramGQL`.`updatedAt`**](#updated-at) **●** [**`DateTime!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/date-time.md)

[**`ProgramGQL`.`owner`**](#owner) **●** [**`String!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

[**`ProgramGQL`.`startDate`**](#start-date) **●** [**`DateTime`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/date-time.md)

[**`ProgramGQL`.`endDate`**](#end-date) **●** [**`DateTime`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/date-time.md)

[**`ProgramGQL`.`variant`**](#variant) **●** [**`ProgramVariantType!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/enums/program-variant-type.md)

Program variant type (linear or non-linear)

[**`ProgramGQL`.`courseCompletionCount`**](#course-completion-count) **●** [**`Int`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/int.md)

Number of courses required for completion in non-linear programs

[**`ProgramGQL`.`courseEnrollment`**](#course-enrollment) **●** [**`CourseEnrollmentType!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/enums/course-enrollment-type.md)

Course enrollment type for the program

[**`ProgramGQL`.`canvasAccountId`**](#canvas-account-id) **●** [**`String`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

Canvas account that owns the program. Null wherever the enrollee view applies. `programs` and `programsPaginated` return the enrollee view when `accountId` is omitted. Null for a program whose account has not been backfilled yet; an unstamped program belongs to the root account.

[**`ProgramGQL`.`canvasAccountName`**](#canvas-account-name) **●** [**`String`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/string.md)

Name of the Canvas account that owns the program. Null wherever the enrollee view applies, and otherwise null unless the caller asked through a partitioned, account-scoped query.

[**`ProgramGQL`.`requirements`**](#requirements) **●** [**`[ProgramRequirementGQL!]!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/program-requirement-gql.md)

[**`ProgramGQL`.`enrollments`**](#enrollments) **●** [**`[ProgramEnrollmentGQL!]!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/program-enrollment-gql.md)

[**`ProgramGQL`.`progresses`**](#progresses) **●** [**`[ProgramProgressGQL!]!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/program-progress-gql.md)

[**`ProgramGQL`.`uniqueSkills`**](#unique-skills) **●** [**`Float!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/scalars/float.md)

[**`ProgramGQL`.`skills`**](#skills) **●** [**`[SkillTaxonomySkillGQL!]!`**](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/skill-taxonomy-skill-gql.md)

#### Returned By

[`createProgram`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/mutations/create-program.md) mutation ● [`duplicateProgram`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/mutations/duplicate-program.md) mutation ● [`enrolledPrograms`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/queries/enrolled-programs.md) query ● [`program`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/queries/program.md) query ● [`programs`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/queries/programs.md) query ● [`updateProgramMetadata`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/operations/mutations/update-program-metadata.md) mutation

#### Member Of

[`PopulatedSimilarSkillGQL`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/populated-similar-skill-gql.md) object ● [`ProgramsPaginatedResponseGQL`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/programs-paginated-response-gql.md) object ● [`SkillTaxonomySkillGQL`](https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/skill-taxonomy-skill-gql.md) object


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developerdocs.instructure.com/services/journey/graphql-api-specification/types/objects/program-gql.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
