---
title: "Get Document Creation Job Status"
method: GET
path: "/v1/documents/import/jobs/{jobId}"
tags: ["Document Access"]
---

# Get Document Creation Job Status

`GET /v1/documents/import/jobs/{jobId}`

## Request

- Base URL: `https://api.lucid.co`
- URL: `https://api.lucid.co/v1/documents/import/jobs/{jobId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://lucid.app/oauth2/authorize`
    - Token URL: `https://api.lucid.co/oauth2/token` scopes: `lucidchart.document.content`, `lucidchart.document.app.folder`, `lucidspark.document.content`, `lucidspark.document.app.folder`
- TypeScript: <https://skmtc.dev/lucid/apis/lucid-rest-api/docs/v1/documents/import/jobs/:jobId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the status of an asynchronous document import. When the job succeeds, `response.document` contains the imported document resource.

## Path parameters

- `jobId` string, required: Unique identifier for an asynchronous job

## Response `200`

OK. Returns the job status and, after a successful import, the imported document.

- ImportDocumentJobStatusResponse
  - `jobId` string, required: Unique identifier for an asynchronous job
  - `status` 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED', required: Current status of the import job.
  - `response` ImportDocumentResult
    - `document` Document, required
      - `documentId` string, uuid, required: Unique ID of the document
      - `title` string, required: Title of the document
      - `editUrl` string, uri, required: Link to edit the document
      - `viewUrl` string, uri, required: Link to view the document
      - `version` integer, required: Most recent version
      - `pageCount` integer, required: Number of pages within the document
      - `canEdit` boolean, required: If requesting user can edit the document
      - `created` string, date-time, required: Date and time of when the document was created
      - `creatorId` integer, required: ID of user who created and owns the document
      - `lastModified` string, date-time, required: Date and time of when the document was last modified
      - `lastModifiedUserId` integer, required: ID of user who most recently modified the document
      - `customAttributes` CustomAttribute[], required: List of any custom attributes belonging to the document. Populated for Enterprise Accounts only.
        - `type` 'singleLineText' | 'multiLineText' | 'singleSelectDropdown' | 'multiSelectDropdown' | 'webLink' | 'numericalRange' | 'hierarchyDropdown', required: The custom attribute type
        - `name` string, nullable: Title of the custom attribute. hierarchyDropdown attributes do not have names.
        - `value` union: The value assigned to the custom attribute. The type of this value is determined by the Attribute Type.
          - string
          - number
          - union[]
            - union
              - …
      - `customTags` string[], required: List of any custom tags assigned to the document
      - `product` 'lucidchart' | 'lucidscale' | 'lucidspark', required: The Lucid Suite product that a document was created in.
      - `status` string, nullable: Current assigned status of the document
      - `classification` string, nullable: Current assigned classification of the document
      - `classificationId` string, uuid, nullable: Current assigned classification ID of the document.
      - `trashed` string, date-time, nullable: If defined, the timestamp when the document was moved to the trash
      - `parent` integer, nullable: ID of the parent folder
      - `repository` Repository
        - `repositoryId` string: the ID of the repository
      - `accountId` integer, nullable, required: ID of Lucid account that owns the document
      - `owner` DocumentOwner
        - `id` number: Id of either the user or the account, depending on the type of the document user resource.
        - `type` string: Specifies if the owner resource is referring to a user or an account. Value will be either "user" or "account".
        - `name` string: Full name of the user that owns this document. This field is excluded if this document is owned by an account.

## Other responses

- `400`: Bad Request. The job ID is malformed.
- `403`: Forbidden. The caller does not have permission to access the import job.
- `404`: Not Found. The import job does not exist.

## Changes

- **2026-11-03** `9c2c917ec59c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lucid/apis/lucid-rest-api/changes/v1/documents/import/jobs/:jobId/get.md)

---

[API](https://skmtc.dev/lucid/apis/lucid-rest-api.md) - [All operations](https://skmtc.dev/lucid/apis/lucid-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lucid/apis/lucid-rest-api/revisions/9c2c917ec59c?raw)