Skip to main content
GET
/
v1
/
import-batches
/
{batchId}
Get import batch detail
curl --request GET \
  --url http://localhost:3001/v1/import-batches/{batchId}
{
  "id": "<string>",
  "organizationId": "<string>",
  "importProfileId": "<string>",
  "sourceType": "<string>",
  "provider": "<string>",
  "integrationKey": "<string>",
  "originalFileName": "<string>",
  "fileStorageKey": "<string>",
  "fileHash": "<string>",
  "status": "<string>",
  "totalRows": 123,
  "validRows": 123,
  "warningRows": 123,
  "failedRows": 123,
  "createdByUserId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "auditEvents": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "paymentIntentId": "<string>",
      "caseId": "<string>",
      "rawRecordId": "<string>",
      "importBatchId": "<string>",
      "eventType": "<string>",
      "actor": "<string>",
      "payload": {},
      "message": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Path Parameters

batchId
string
required
Minimum string length: 1

Response

Default Response

id
string
required
organizationId
string
required
importProfileId
null | string
required
sourceType
string
required
provider
null | string
required
integrationKey
null | string
required
originalFileName
string
required
fileStorageKey
string
required
fileHash
string
required
status
string
required
totalRows
integer
required
validRows
integer
required
warningRows
integer
required
failedRows
integer
required
createdByUserId
null | string
required
createdAt
string<date-time>
required
completedAt
null | string<date-time>
required
auditEvents
AuditEventSnapshot ยท object[]
required