# Retrieve the list of synthetic data generation jobs.

Endpoint: GET /synthetic/jobs
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies a descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The id of the synthetic data generation job
    Example: 5ff0dab4-368c-4d57-8b61-9a09b6e8faf3

  - `items.name` (string, required)
    The name of this job. This value must be unique among all synthetic data generation jobs.
    Example: Customer Data Generation Job

  - `items.description` (string)
    An optional description for this synthetic data generation job.
    Example: Job to generate synthetic customer data for testing

  - `items.dataset_id` (string, required)
    The ID of the dataset this job will use for generation
    Example: dataset-7bb1fab6-560e-6d79-cb82-9c4f73e5d0e4

  - `items.dataset_name` (string)
    The name of the dataset this job will use for generation
    Example: Customer Dataset

  - `items.application_id` (string)
    The ID of the application this job belongs to
    Example: app-5ff0dab4-368c-4d57-8b61-9a09b6e8faf2

  - `items.application_name` (string)
    The name of the application this job belongs to
    Example: Customer Data Application

  - `items.account_id` (integer)
    The ID of the account who created this job.
    Example: 1

  - `items.creation_date` (string)
    The date this job was created.
    Example: 2022-11-30T08:51:34.148Z

  - `items.updated_date` (string)
    The date this job was last updated.
    Example: 2022-11-30T09:15:20.000Z

  - `items.records_count_overrides` (object)
    Records count overrides for one or more structures. Used for dataset/job patch requests and estimate previews.
    Example: {"structures":[{"structure_id":"101","records_count":5000},{"structure_id":"202","records_count_multiplier":3.5}]}

  - `items.records_count_overrides.structures` (array)
    List of structure records count updates. Each item must set either records_count (for top-level structures) or records_count_multiplier (for child structures), not both.

  - `items.records_count_overrides.structures.structure_id` (string, required)
    The id of the structure to update.
    Example: 101

  - `items.records_count_overrides.structures.records_count` (integer)
    Absolute record count. Only valid for top-level structures (parent_structure_id IS NULL). Minimum value is 0.
    Example: 5000

  - `items.records_count_overrides.structures.records_count_multiplier` (number)
    Ratio of child records to parent records. Only valid for child structures (parent_structure_id IS NOT NULL). Minimum value is 0.
    Example: 3.5

  - `items.latest_execution_start_time` (string)
    The start time of the most recent execution of this job
    Example: 2022-11-30T10:30:00.000Z

  - `items.latest_execution_status` (string)
    The status of the most recent execution of this job
    Example: SUCCESS

  - `items.target_mappings` (array)
    List of target connector mappings for this job

  - `items.target_mappings.job_id` (string)
    The ID of the job this mapping belongs to

  - `items.target_mappings.reference_connector_id` (string)
    The ID of the reference connector

  - `items.target_mappings.target_connector_id` (string)
    The ID of the target connector (can be null)

  - `items.target_mappings.target_connector_name` (string)
    The name of the target connector

  - `items.target_mappings.target_connector_type` (string)
    The type of the target connector

  - `items.truncate_existing_data` (boolean)
    When true, existing data in the target schema is deleted before generation begins. When false (default), generated data is appended to existing rows. Can be changed at any time via PATCH.

  - `items.use_job_seed` (boolean)
    When true, the job uses a deterministic seed for data generation so that truncate-and-regenerate produces identical data. Defaults to false.

  - `items.job_seed` (string)
    Opaque seed value used for deterministic data generation when use_job_seed is true. Generated automatically at job creation and cannot be changed.

  - `items.tags` (array)
    Tags associated with this job.

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.