Skip to main content
GET
/
imports
/
{importId}
Gets an import by id
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/imports/{importId} \
  --header 'Authorization: Bearer <token>'
{
  "importId": "<string>",
  "type": "API",
  "status": "NOT_STARTED",
  "personCount": 123,
  "failedRecords": [
    {
      "personId": "<string>"
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
importId
string
required

The ID of the import

Response

Information about the import

​
importId
string
required

The ID of the import

​
type
enum<string>
required

Type of the import.

Available options:
API,
ACTIVITIES,
CSV
​
status
enum<string>
required

Status of the import.

Available options:
NOT_STARTED,
UPLOADING,
ERROR,
COMPLETED
​
personCount
integer
required

The number of people that were imported

​
failedRecords
object[] | null
required
  • Option 1
  • Option 2
​
updatedAt
string<date-time>
required

Timestamp the import finished.