List all users

GET

/business/user-management/users

• production API Server

Returns a paginated list of users 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 users by name, email, or signatory information

sort_field

string

Allowed values: first_name last_name email role is_archived has_signature signatory_name signatory_designation created_at updated_at

Field to sort by

sort_order

string

Allowed values: asc desc

Sort direction

Responses

200

Successful operation

object

data

Array<object>

object

uuid

Unique identifier for the user

string format: uuid

66c9c977-f379-4692-9d5c-f989c17543ee

institution_id

ID of the institution this user belongs to

integer

3

first_name

First name of the user

string

Faizan

last_name

Last name of the user

string

Ali

email

Email address of the user

string format: email

faizananwer2011@gmail.com

email_verification_status

Email verification status

string

Allowed values: verified unverified

verified

email_verified_at

When the email was verified

string format: date-time

nullable

2025-02-03T12:54:19.000000Z

phone

Phone number of the user

string

+971569158359

phone_verification_status

Phone verification status

string

Allowed values: verified unverified

verified

phone_verified_at

When the phone was verified

string format: date-time

nullable

2025-02-03T11:47:51.000000Z

is_archived

Whether the user is archived

boolean

has_signature

Whether the user has a signature

boolean

true

signature

URL to the user’s signature image

string format: uri

nullable

https://api.vec.digital/storage/signatures/75fd0390-099a-47bc-963e-e3be09ab2c2b.png

signature_added_at

When the signature was added

string format: date-time

nullable

2025-03-13T14:05:28.000000Z

signatory_name

Name to use when signing certificates

string

nullable

Faizan Ali

signatory_designation

Designation/role to use when signing certificates

string

nullable

Software Developer

avatar

URL to the user’s avatar

string format: uri

https://api.vec.digital/storage/avatars/avatar_67765e0c784a00.82650762.png

setup_status

Setup status of the user

string

Allowed values: pending completed

completed

created_at

Creation timestamp

string format: date-time

2024-10-16T19:15:50.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-13T14:05:28.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