Customers

Imports

These endpoints are used to import data into Trybe

The Import object

Attributes

  • iduuidrequired

    The ID of the import

  • typestringrequired

    The kind of records contained in the upload, which determines the validator and row-schema the import is checked against. The value cannot be changed after creation; create a new import if you need to load a different entity type.

    Possible values:clientpremier_coreappointment_typesession_typearea_booking_typeretail_productpackageinventory_productvoucher
  • statusstringrequired

    The status of the import

    Possible values:validatingvalidatedimportingimportedrolling_backrolled_backerrored
  • total_rowsintegerrequired

    The total number of rows in the import

  • imported_rowsintegerrequired

    The number of rows that have been imported

  • failed_validation_rowsintegerrequired

    The number of rows that didn't pass validation

  • failed_import_rowsintegerrequired

    The number of rows that failed to import

  • premier_core_mapping_idobject-idoptional

    The ID of the Premier Core mapping that was used for this import.

    This field is only present when the type is premier_core.

  • created_atdate-timerequired

    The time the import was created

  • updated_atdate-timerequired

    The time the import was last updated

  • validated_atdate-timeoptionalnullable

    The time the import was validated (successful or unsuccessful).

  • imported_atdate-timeoptionalnullable

    The time the import was completed.

  • rolled_back_atdate-timeoptionalnullable

    The time the import was rolled back.

  • progressintegerrequired

    The percentage of the import that has been completed.

  • created_byrequired

    The user who created the import

{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "client",
  "status": "running",
  "total_rows": 1000,
  "imported_rows": 950,
  "failed_validation_rows": 0,
  "failed_import_rows": 0,
  "premier_core_mapping_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "created_at": "2026-01-15T09:30:00+00:00",
  "updated_at": "2026-01-15T09:30:00+00:00",
  "validated_at": "2026-01-15T09:30:00+00:00",
  "imported_at": "2026-01-15T09:30:00+00:00",
  "rolled_back_at": "2026-01-15T09:30:00+00:00",
  "progress": 95,
  "created_by": "string"
}