Skip to main content
Retrieve all processing jobs associated with a specific project. The response is an array of Job objects ordered by creation time, newest first. Use this endpoint to audit job history, reconcile billing, or surface the current in-progress job for a project.

Authentication

Include your API key as Authorization: Bearer YOUR_API_KEY in the request headers.

Endpoint

GET https://plangrep.com/api/open/v1/projects/{projectId}/jobs

Path Parameters

projectId
string
required
The unique identifier of the project whose jobs you want to list. Returned as project.id from Create Project or List Projects.

Example Request

curl --request GET \
  --url https://plangrep.com/api/open/v1/projects/proj_01hx9z4kqr8e7m3p5n6w2v0abc/jobs \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Response Fields

jobs
Job[]
required
Array of all jobs belonging to the specified project, ordered by creation time (newest first).

Example Response

{
  "jobs": [
    {
      "id": "job_01hy3m8qtn2e5r7k9p0w4x1def",
      "externalId": "order-7890",
      "status": "completed",
      "projectId": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
      "limits": {
        "maxDeclaredBytes": 10000000000,
        "maxFiles": 100
      },
      "pageCount": 204,
      "successfulPageCount": 204,
      "billing": {
        "creditsDebited": 1824
      },
      "files": [
        {
          "id": "file_xyz789",
          "fileName": "architectural_drawings.pdf",
          "status": "completed"
        }
      ],
      "resultUrl": "https://storage.plangrep.com/results/job_01hy3m8qtn2e5r7k9p0w4x1def?token=...",
      "error": null,
      "createdAt": "2024-11-02T09:00:00.000Z",
      "updatedAt": "2024-11-02T09:45:10.000Z",
      "completedAt": "2024-11-02T09:45:10.000Z",
      "expiresAt": "2024-11-09T09:00:00.000Z"
    },
    {
      "id": "job_01hx9z5abc2d3e4f5g6h7i8jkl",
      "externalId": null,
      "status": "cancelled",
      "projectId": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
      "limits": {
        "maxDeclaredBytes": 10000000000,
        "maxFiles": 100
      },
      "pageCount": 0,
      "successfulPageCount": 0,
      "billing": {
        "creditsDebited": 0
      },
      "files": [],
      "resultUrl": null,
      "error": null,
      "createdAt": "2024-11-01T16:30:00.000Z",
      "updatedAt": "2024-11-01T16:31:05.000Z",
      "completedAt": "2024-11-01T16:31:05.000Z",
      "expiresAt": "2024-11-08T16:30:00.000Z"
    }
  ]
}
Jobs are returned for the authenticated organization only. To retrieve full details or the result for a specific job, use Get Job or Get Job Result with the individual jobId.