---
updatedAt: 2026-06-25T13:09:18.000Z
agentTools:
  projectIndex: https://marketing.developer.dotdigital.com/llms.txt
---

# Gets an enrolment by ID.

<br />

Use this operation to retrieve a program enrolment and its status by its ID (GUID).

In the response, there are three status types:

* **Processing**\
  The enrolment is currently processing and has yet to finish
* **Finished**\
  The enrolment has finished processing
* **NotAvailableInThisVersion**\
  This feature is not available in the version of the API you're using

<span class="callRateHigh" />

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Programs",
    "description": "Manage automation programs and enrolments. Use this API to list all programs,\nretrieve a specific program by ID, create enrolments for contacts or address\nbooks into a program, check enrolment status, retrieve enrolments filtered by\nstatus, and download a fault report listing contacts that failed to enrol.",
    "version": "2.0.1"
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "x-samples-languages": [
    "curl",
    "csharp",
    "java",
    "javascript",
    "node",
    "python",
    "php",
    "ruby"
  ],
  "externalDocs": {
    "description": "Learn more about Dotdigital APIs",
    "url": "https://developer.dotdigital.com"
  },
  "servers": [
    {
      "url": "https://{region}-api.dotdigital.com",
      "variables": {
        "region": {
          "default": "r1",
          "enum": [
            "r1",
            "r2",
            "r3"
          ],
          "description": "The Dotdigital region id your account belongs to"
        }
      }
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/v2/programs/enrolments/{enrolmentId}": {
      "get": {
        "summary": "Gets an enrolment by ID.",
        "operationId": "getProgramEnrolmentById",
        "tags": [
          "Programs"
        ],
        "parameters": [
          {
            "name": "enrolmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "The unique identifier of the enrolment."
          }
        ],
        "responses": {
          "200": {
            "description": "The enrolment matching the specified ID.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid",
                      "description": "The unique identifier of the enrolment."
                    },
                    "programId": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The ID of the program enrolled onto."
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "NotAvailableInThisVersion",
                        "Processing",
                        "Finished"
                      ],
                      "description": "The processing status of the enrolment."
                    },
                    "dateCreated": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The UTC date and time the enrolment was created."
                    },
                    "contacts": {
                      "type": "array",
                      "items": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "description": "The contact IDs included in the enrolment."
                    },
                    "addressBooks": {
                      "type": "array",
                      "items": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "description": "The address book IDs included in the enrolment."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials."
          },
          "403": {
            "description": "The account does not have the Programs permission."
          },
          "404": {
            "description": "No enrolment was found with the specified ID (`ERROR_ENROLMENT_NOT_FOUND`).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "A description of the error."
                    }
                  }
                },
                "example": {
                  "message": "Error: ERROR_ENROLMENT_NOT_FOUND"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  }
}
```

# Sibling pages

* [Create program enrolment](https://marketing.developer.dotdigital.com/reference/create-program-enrolment.md)
* [Get programs](https://marketing.developer.dotdigital.com/reference/get-programs.md)
* [Get program by ID](https://marketing.developer.dotdigital.com/reference/get-program-by-id.md)
* [Gets enrolments by status.](https://marketing.developer.dotdigital.com/reference/get-programenrolments-by-status.md)
* [Get program enrolment report faults](https://marketing.developer.dotdigital.com/reference/get-program-enrolment-report-faults.md)