---
updatedAt: 2026-08-06T09:19:22.000Z
agentTools:
  projectIndex: https://docs.data.one/llms.txt
---

# Get Job

Gets an asynchronous job by `jobId`. The response includes the current job status and job-type-specific metadata, where available, to provide additional context about the job.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "info": {
    "version": "v1",
    "title": "Asynchronous Operations",
    "description": "Endpoints for asynchronous jobs and long-running operations."
  },
  "paths": {
    "/v1/jobs/{jobId}": {
      "get": {
        "tags": [
          "Jobs"
        ],
        "operationId": "getJob",
        "summary": "Get Job",
        "description": "Gets an asynchronous job by `jobId`. The response includes the current job status and job-type-specific metadata, where available, to provide additional context about the job.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/JobId"
          }
        ],
        "responses": {
          "200": {
            "description": "Job found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetJobResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/ApiKeyUnauthorizedError"
          },
          "404": {
            "description": "The `jobId` does not exist for the requesting partner."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Secret API key used for authentication."
      }
    },
    "schemas": {
      "OnDemandRefreshAccountJobMetadata": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid",
            "description": "Open banking account ID."
          },
          "status": {
            "type": "string",
            "enum": [
              "CREATED",
              "IN_PROGRESS",
              "COMPLETED",
              "FAILED"
            ],
            "description": "Current terminal or in-progress status for this account within the refresh job."
          },
          "failureReason": {
            "type": "string",
            "enum": [
              "PROVIDER_UNEXPECTED_ERROR",
              "REAUTHENTICATION_REQUIRED",
              "REVOKED_ACCESS",
              "ACCOUNT_UNREACHABLE"
            ],
            "description": "Failure reason for failed account refreshes when available."
          }
        },
        "required": [
          "accountId",
          "status"
        ]
      },
      "OnDemandRefreshJobMetadata": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "format": "uuid"
          },
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OnDemandRefreshAccountJobMetadata"
            }
          }
        },
        "required": [
          "userId",
          "accounts"
        ]
      },
      "EmptyGetJobResponseMetadata": {
        "type": "object",
        "additionalProperties": false,
        "description": "Empty metadata for job types with no job type specific metadata."
      },
      "GetJobResponseMetadata": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/OnDemandRefreshJobMetadata"
          },
          {
            "$ref": "#/components/schemas/EmptyGetJobResponseMetadata"
          }
        ],
        "description": "Job type specific metadata. The shape depends on `jobType`."
      },
      "GetJobResponse": {
        "type": "object",
        "properties": {
          "jobId": {
            "type": "string",
            "format": "uuid"
          },
          "jobType": {
            "type": "string",
            "enum": [
              "ACCOUNT_REFRESH",
              "CAAS"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "CREATED",
              "IN_PROGRESS",
              "COMPLETED",
              "FAILED"
            ]
          },
          "created": {
            "type": "string",
            "format": "date-time"
          },
          "updated": {
            "type": "string",
            "format": "date-time"
          },
          "metadata": {
            "$ref": "#/components/schemas/GetJobResponseMetadata"
          }
        },
        "required": [
          "jobId",
          "jobType",
          "status",
          "created",
          "updated",
          "metadata"
        ],
        "example": {
          "jobId": "a55a649f-e3a3-4d09-ae62-643889e5ad76",
          "jobType": "ACCOUNT_REFRESH",
          "status": "COMPLETED",
          "created": "2025-01-15T10:30:00Z",
          "updated": "2025-01-15T10:32:00Z",
          "metadata": {
            "userId": "008ffb06-ede5-4888-ac61-449a3d95f80f",
            "accounts": [
              {
                "accountId": "b4fdd22e-9c36-43f0-b4c5-8a351a20961d",
                "status": "COMPLETED"
              },
              {
                "accountId": "bb4c8286-d4be-4858-9839-930f358c8cd0",
                "status": "FAILED",
                "failureReason": "ACCOUNT_UNREACHABLE"
              }
            ]
          }
        }
      }
    },
    "responses": {
      "ApiKeyUnauthorizedError": {
        "description": "API key authentication unsuccessful."
      }
    },
    "parameters": {
      "JobId": {
        "in": "path",
        "name": "jobId",
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "required": true,
        "description": "The `jobId` value returned when an asynchronous job was created.",
        "example": "a55a649f-e3a3-4d09-ae62-643889e5ad76"
      }
    }
  }
}
```