Skip to main content

Get batch agreement by id

GET 

/v2/agreement-batches/:id

Get batch agreement by id

Request

Path Parameters

    id stringrequired

    Batch id

Responses

OK

Schema

    id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    status BatchStatus (string)

    Possible values: [IN_PROGRESS, PROCESSED, FAILED]

    batch_name string

    Name of the batch

    processed int32

    Number of processed items in the batch

    total int32

    Total number of items in the batch

Loading...