List all batches

GET

/business/batches

• production API Server

Returns a paginated list of certificate batches for the authenticated institution.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

per_page

integer

default: 15 >= 1 <= 100

Number of items per page (default 15, max 100)

page

integer

default: 1 >= 1

Page number (starts from 1)

status

string

Allowed values: pending processing completed partially_completed failed waiting_for_approval

Filter batches by status

Responses

200

Successful operation

object

data

Array<object>

object

id

Unique identifier for the batch

string format: uuid

9e7860e3-7c0a-401f-98f6-b98e316934f4

name

Name of the batch

string

Class 10th, 2024

status

Current status of the batch

string

Allowed values: pending processing completed partially_completed failed waiting_for_approval

completed

template_id

ID of the certificate template used

string format: uuid

9d76a768-d016-4364-b18b-32c647adad0c

total_certificates

Total number of certificates in the batch

integer

1

processed_certificates

Number of successfully processed certificates

integer

1

failed_certificates

Number of failed certificates

integer

0

progress

Progress percentage (0-100)

number format: float

100

completion_date

When the batch was completed

string format: date-time

nullable

2025-03-14T13:04:03.000000Z

created_at

Creation timestamp

string format: date-time

2025-03-14T13:02:19.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-14T13:04:03.000000Z

links

object

first

URL to the first page

string

https://api.vec.digital/business/certificate-templates?page=1

last

URL to the last page

string

https://api.vec.digital/business/certificate-templates?page=2

prev

URL to the previous page (null if on first page)

string

nullable

next

URL to the next page (null if on last page)

string

nullable

https://api.vec.digital/business/certificate-templates?page=2

meta

object

current_page

Current page number

integer

1

from

Index of the first item on the current page

integer

1

last_page

Total number of pages

integer

2

links

Pagination links

Array<object>

object

url

string

nullable

https://api.vec.digital/business/certificate-templates?page=2

label

string

2

active

boolean

path

Base URL path for pagination

string

https://api.vec.digital/business/certificate-templates

per_page

Items per page

integer

15

to

Index of the last item on the current page

integer

15

total

Total number of items

integer

25

401

Authentication failed

object

message

Error message

string

Unauthorized - Invalid API token

403

Permission denied

object

message

Error message

string

Forbidden - Insufficient permissions

required_permission

Required permission to access this resource

string

batches:view

500

Server error

object

message

Error message

string

An unexpected error occurred. Our team has been notified.

error_code

Error code

string

SERVER_ERROR