Skip to content
Collect
/
/
Returns a list of records...

Returns a list of records with the specified batch_id

Request

Returns a list of records with the specified batch_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

batch_idstringrequired

The batch_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/batch/{batch_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(WriteOff)
LastEvaluatedKeystring
Response
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}