Get a specific job definition

APIs & SDKs

GEThttps://api.vercel.com/v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}

Get Job Definition

https://api.vercel.com/v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}

const response = await fetch('https://api.vercel.com/v1/vercel-ci/invocations/invocationId/attempts/attempt/job-definitions/jobDefinitionId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "jobDefinition": {
    "invocationId": "example_id",
    "invocationAttempt": "123",
    "jobDefinitionId": "example_id",
    "kind": "string",
    "name": "Example Name",
    "command": "string",
    "createdAt": "123"
  }
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

invocationIdstringRequired

attemptstringRequired

jobDefinitionIdstringRequired

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Successfully fetched the job definition.

jobDefinitionobjectRequired

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

errorobjectRequired

403You do not have permission to access this resource.

errorobjectRequired

404Error

410Error

429Error

errorobjectRequired

500Error

errorobjectRequired

Cross-link map: Get a specific job definition (/docs/rest-api/vercel-ci/get-a-specific-job-definition)

From the Vercel docs graph (built 2026-10-13T05:35:52.211Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

List job definitions for an invocation attempt — GET /v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions — List Job Definitions
Get a specific job run attempt — GET /v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}/runs/{runAttempt} — Ge
List all task definitions for a job run — GET /v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}/runs/{runAttempt}/task
List all runs for a job definition — GET /v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}/runs — List Job Runs
Get an invocation with its jobs and tasks — GET /v1/vercel-ci/invocations/{invocationId}/tree — Returns an invocation attempt together with every job definition, it

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}

const response = await fetch('https://api.vercel.com/v1/vercel-ci/invocations/invocationId/attempts/attempt/job-definitions/jobDefinitionId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "jobDefinition": {
    "invocationId": "example_id",
    "invocationAttempt": "123",
    "jobDefinitionId": "example_id",
    "kind": "string",
    "name": "Example Name",
    "command": "string",
    "createdAt": "123"
  }
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

OpenAPI Specification