Imports

Gets an import by id

get/imports/{importId}

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/imports/{importId}
  • Auth: HTTP bearer

Path parameters

importIdstring required

The ID of the import

Response

Information about the import

importIdstring required

The ID of the import

type'API' | 'MCP' | 'ASSISTANT' | 'ACTIVITIES' | 'CSV' required

Type of the import.

status'NOT_STARTED' | 'UPLOADING' | 'ERROR' | 'COMPLETED' required

Status of the import.

personCountinteger required

The number of people that were imported

partialReasonsstring[] required

Why a completed import is partial. RECORDS_FAILED means some records were not imported (see failedRecords). SELECT_OPTION_LIMIT_REACHED means people were imported but new select option values were left off because the property is at its option limit (see warnings). Empty when the import fully succeeded, is still running, or failed.

updatedAtstring date-time required

Timestamp the import finished.

Changes

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