Imports

Get a custom field import

Returns the import with live per-status row counts. status moves queued → running → completed; poll until it is completed, then read failures from the rows endpoint with ?status=failed. completed means every row reached an outcome, including all of them failing. Should a run stop after repeated errors, the rows it never reached fail with code IMPORT_ABORTED and the import still completes; resubmit those rows.

Requires the permission to view project settings, as reading a project's custom fields does. Any service account of the submitting organization with that permission can read its imports.

get/imports/custom-fields/{importId}

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/imports/custom-fields/{importId}
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Path parameters

importIdstring uuid required

Import UUID, from the 202 that accepted it.

Response

The import.

Example response

{
  "data": {
    "id": "0199300a-6f6e-7c7e-9d3e-2f4a8b1c5d6e",
    "row_count": 10000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.