---
title: "List all jobs."
method: GET
path: "/v1/{tenantId}/jobs"
tags: ["Job"]
---

# List all jobs.

`GET /v1/{tenantId}/jobs`

## Request

- Base URL: `https://virtserver.swaggerhub.com/open83/crystal/1.0.0`
- URL: `https://virtserver.swaggerhub.com/open83/crystal/1.0.0/v1/{tenantId}/jobs`
- Auth: none declared

## Query parameters

- `type` 'migration'
- `offset` integer
- `limit` integer
- `sort` string

## Response `200`

successful operation.

- object
  - `jobs` Job[]
    - `Id` string: The plan ID, generated by server
    - `TenantId` string: The tenant UUID in a multi-tenancy environment.
    - `UserId` string: The User UUID in a multi-tenancy environment.
    - `TriggerType` 'auto' | 'manual': The migration triggering operation type.
    - `Type` 'migration': The plan type. Till now only migration support. New types will be added in the future.
    - `PlanName` string: The name of plan job belongs to.
    - `PlanId` string: The id of plan job belongs to.
    - `SourceLocation` string: The source data migrate or replicate from.
    - `DestLocation` string: The target data migrate or replicate to.
    - `CreateTime` integer: The time job is created.
    - `StartTime` integer: The time job started to run.
    - `EndTime` integer: The time job ended.
    - `Status` 'pending' | 'running' | 'succeed' | 'failed': The status of job.
    - `TotalCapacity` integer: The total capacity that should be migrated.
    - `PassedCapacity` integer: The capacity that have been migrated.
    - `MigratedCapacity` integer: The capacity that have been migrated till now.
    - `TotalCount` integer: The total count of objects that should be migrated.
    - `PassedCount` integer: The count that have been migrated.
    - `Progress` integer: The progress of job, represented by percentage.
    - `RemainSource` boolean: Flag indicating whether to keep the content of source bucket
  - `next` integer

## Other responses

- `401`: Unauthorized. Token not found in header

---

[API](https://skmtc.dev/sodafoundation/apis/soda-crystal-api.md) - [All operations](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/revisions/c02dd33a522b?raw)