List all certificate templates

GET

/business/certificate-templates

• production API Server

Returns a paginated list of certificate templates 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)

search

string

Search term to filter templates by name

Responses

200

Successful operation

object

data

Array<object>

object

id

Unique identifier for the template

string format: uuid

9e3b101f-c264-4f97-945f-20dfa7163768

institution_id

ID of the institution that owns this template

integer

3

name

Name of the template

string

Certificate 2

screenshot

URL to the template screenshot

string format: uri

https://api.vec.digital/storage/certificate_templates/67ca927729685_1741329015.png

has_signatures

Whether this template has signatory fields. If true, signatories must be provided (or default signatories configured) when creating a batch.

boolean

true

has_default_signatories

Whether this template has default signatories configured. If true, you can create a batch without providing signatories.

boolean

requires_signature_setup

True when the template has signatory fields but no default signatories are configured. You must provide signatories explicitly when creating a batch with this template.

boolean

true

signatory_fields

List of signatory field identifiers defined in the template canvas.

Array<string>

[
  "signatory_1",
  "signatory_2"
]

default_signatories

Default signatories configured for this template. Only present when has_default_signatories is true.

Array<object>

nullable

object

id

integer

1

signatory_index

integer

1

institution_user_id

integer

3

display_name

string

nullable

Faizan Ali

designation

string

nullable

Software Developer

auto_approve

boolean

user

object

id

integer

3

uuid

string format: uuid

66c9c977-f379-4692-9d5c-f989c17543ee

first_name

string

Faizan

last_name

string

Ali

email

string format: email

faizan@example.com

signatory_name

string

nullable

Faizan Ali

signatory_designation

string

nullable

Software Developer

created_at

Creation timestamp

string format: date-time

2025-02-17T04:05:07.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-07T06:30:15.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