Retrieve a LinX Batch

Retrieve a LinX batch.

Endpoint

GET /v2/linx/workflow-batches/{batchId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

batchId REQUIRED

string (UUID)

ID of the LinX batch.

Request Body

None

Returns

Returns the LinX Batch Detail object.

SAMPLE RESPONSE

				
					{
  "id": "93f1e6dd-5dc7-4660-91cc-5cb949b74c6d",
  "status": "ACTIVE",
  "templateId": "eb9b3097-9b8b-463f-ab61-a6dbd93cb88d",
  "templateVersionId": "18c49ebd-f144-4ba8-abce-25068220176c",
  "templateVersion": 2,
  "templateDisplayName": "Send a rebate",
  "activeRequestsCount": 10,
  "cancelledRequestsCount": 0,
  "completedRequestsCount": 20,
  "declinedRequestsCount": 0,
  "expiredRequestsCount": 0,
  "failedRequestsCount": 0,
  "rejectedRequestsCount": 0,
  "totalRequestsCount": 30,
  "createdBy": {
    "id": "03522665-75af-4e4e-b37d-f74f31ecbe85",
    "type": "service-account"
  },
  "createdAt": "2024-08-28T16:02:01.667Z",
  "updatedBy": {
    "id": "03522665-75af-4e4e-b37d-f74f31ecbe85",
    "type": "service-account"
  },
  "updatedAt": "2024-09-28T16:02:01.667Z"
}