LUlucid
Document Access

Get Document Creation Job Status

Changed on

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

get/v1/documents/import/jobs/{jobId}

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopeslucidchart.document.content, lucidchart.document.app.folder, lucidspark.document.content, lucidspark.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

jobIdstring required

Unique identifier for an asynchronous job

Example:jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454

Identifier returned when the import job was created.

Response

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

jobIdstring required

Unique identifier for an asynchronous job

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' required

Current status of the import job.

Example response

{
  "jobId": "jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454",
  "response": {
    "document": {
      "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
      "title": "document title",
      "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",
      "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",
      "version": 101,
      "pageCount": 5,
      "canEdit": false,
      "created": "2019-04-22T13:47:23Z",
      "creatorId": 12345,
      "lastModified": "2020-06-26T16:29:37Z",
      "lastModifiedUserId": 54321,
      "customAttributes": [],
      "customTags": [
        "in progress"
      ],
      "product": "lucidchart",
      "status": "Complete",
      "classification": "Private",
      "trashed": null,
      "parent": null,
      "repository": null,
      "owner": {
        "id": 123456,
        "type": "user",
        "name": "John Doe"
      },
      "accountId": 1234
    }
  }
}

Changes