Passer au contenu principal
GET
/
jobs
/
{id}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.jobs.get("id");
}
main();
{
  "status": "pending",
  "type": "users_import",
  "id": "job_0000000000000001",
  "created_at": "<string>",
  "connection_id": "con_0000000000000001",
  "location": "<string>",
  "percentage_done": 123,
  "time_left_seconds": 123,
  "format": "json",
  "status_details": "<string>",
  "summary": {
    "failed": 0,
    "updated": 0,
    "inserted": 0,
    "total": 0
  }
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string
requis

ID of the job.

Pattern: ^job_[A-Za-z0-9]{16}$

Réponse

Job retrieved successfully.

status
string
défaut:pending
requis

Status of this job.

type
string
défaut:users_import
requis

Type of job this is.

id
string
défaut:job_0000000000000001
requis

ID of this job.

created_at
string

When this job was created.

connection_id
string
défaut:con_0000000000000001

connection_id of the connection this job uses.

location
string

URL to download the result of this job.

percentage_done
integer

Completion percentage of this job.

time_left_seconds
integer

Estimated time remaining before job completes.

format
enum<string>

Format of the file. Must be json or csv.

Options disponibles:
json,
csv
status_details
string

Status details.

summary
object

Job execution summary.