Visitors

Manage visitor passes and visitor events for your office.

Get All Passes

GET/api/hr/visitor/passes

Get all visitor passes for the company.

{ "passes": [ { "id": "...", "visitorName": "Jane Smith", "visitorEmail": "jane@example.com", "visitorPhone": "+1234567890", "purpose": "Meeting", "hostName": "John Doe", "status": "approved", "validFrom": "2024-01-15T09:00:00Z", "validUntil": "2024-01-15T18:00:00Z", "identityCode": "VIS123" } ] }

Create Pass

POST/api/hr/visitor/passes

Create a new visitor pass.

Field	Type	Required	Description
`visitorName`	string	Required	Visitor's full name
`visitorEmail`	string	Required	Visitor's email
`visitorPhone`	string	Optional	Visitor's phone
`purpose`	string	Optional	Visit purpose
`hostName`	string	Optional	Host employee name
`validFrom`	string	Optional	Valid from date (ISO)
`validUntil`	string	Optional	Valid until date (ISO)

{ "pass": { "id": "...", "status": "pending", "identityCode": "VIS456" } }

Get Pass

GET/api/hr/visitor/passes/[id]

Get a specific visitor pass.

Field	Type	Required	Description
`id`	string	Required	Pass ID (path param)

{ "pass": { ... visitor pass object } }

Update Pass

PATCH/api/hr/visitor/passes/[id]

Update visitor pass status or details.

Field	Type	Required	Description
`id`	string	Required	Pass ID (path param)
`status`	string	Optional	New status (approved/rejected/active/completed)
`validFrom`	string	Optional	Updated valid from date
`validUntil`	string	Optional	Updated valid until date

{ "pass": { ... updated pass } }

Get Events

GET/api/hr/visitor/events

Get all visitor events.

{ "events": [ { "id": "...", "slug": "tech-meetup-2024", "visitorCompany": "Tech Inc", "expectedDate": "2024-02-01", "purpose": "Tech Meetup", "hostName": "John Doe", "status": "upcoming" } ] }

Create Event

POST/api/hr/visitor/events

Create a new visitor event.

Field	Type	Required	Description
`slug`	string	Required	URL-friendly identifier
`visitorCompany`	string	Optional	Visiting company name
`expectedDate`	string	Optional	Expected date (ISO)
`purpose`	string	Optional	Event purpose
`hostName`	string	Optional	Host name
`hostEmail`	string	Optional	Host email
`notes`	string	Optional	Additional notes

{ "event": { "id": "...", "slug": "tech-meetup", "status": "upcoming" } }

Get Event

GET/api/hr/visitor/events/[id]

Get a specific visitor event.

{ "event": { ... visitor event object } }

Update Event

PATCH/api/hr/visitor/events/[id]

Update a visitor event.

Field	Type	Required	Description
`status`	string	Optional	New status (upcoming/ongoing/completed)

{ "event": { ... updated event } }

Delete Event

DELETE/api/hr/visitor/events/[id]

Delete a visitor event.

{ "success": true }

Public: Get Event by Slug

GET/api/public/visitor/event/[slug]

Get visitor event by slug (public, no auth required).

Field	Type	Required	Description
`slug`	string	Required	Event slug (path param)

{ "event": { ... public event info } }

Public: Register for Event

POST/api/public/visitor/register/[slug]

Field	Type	Required	Description
`slug`	string	Required	Event slug (path param)
`visitorName`	string	Required	Your name
`visitorEmail`	string	Required	Your email
`visitorPhone`	string	Optional	Your phone
`purpose`	string	Optional	Visit purpose

{ "pass": { "id": "...", "status": "pending", "identityCode": "VIS789" } }

Visitors

Manage visitor passes and visitor events for your office.

Get All Passes

GET/api/hr/visitor/passes

Get all visitor passes for the company.

Create Pass

POST/api/hr/visitor/passes

Create a new visitor pass.

Field	Type	Required	Description
`visitorName`	string	Required	Visitor's full name
`visitorEmail`	string	Required	Visitor's email
`visitorPhone`	string	Optional	Visitor's phone
`purpose`	string	Optional	Visit purpose
`hostName`	string	Optional	Host employee name
`validFrom`	string	Optional	Valid from date (ISO)
`validUntil`	string	Optional	Valid until date (ISO)

{ "pass": { "id": "...", "status": "pending", "identityCode": "VIS456" } }

Get Pass

GET/api/hr/visitor/passes/[id]

Get a specific visitor pass.

Field	Type	Required	Description
`id`	string	Required	Pass ID (path param)

{ "pass": { ... visitor pass object } }

Update Pass

PATCH/api/hr/visitor/passes/[id]

Update visitor pass status or details.

Field	Type	Required	Description
`id`	string	Required	Pass ID (path param)
`status`	string	Optional	New status (approved/rejected/active/completed)
`validFrom`	string	Optional	Updated valid from date
`validUntil`	string	Optional	Updated valid until date

{ "pass": { ... updated pass } }

Get Events

GET/api/hr/visitor/events

Get all visitor events.

{ "events": [ { "id": "...", "slug": "tech-meetup-2024", "visitorCompany": "Tech Inc", "expectedDate": "2024-02-01", "purpose": "Tech Meetup", "hostName": "John Doe", "status": "upcoming" } ] }

Create Event

POST/api/hr/visitor/events

Create a new visitor event.

Field	Type	Required	Description
`slug`	string	Required	URL-friendly identifier
`visitorCompany`	string	Optional	Visiting company name
`expectedDate`	string	Optional	Expected date (ISO)
`purpose`	string	Optional	Event purpose
`hostName`	string	Optional	Host name
`hostEmail`	string	Optional	Host email
`notes`	string	Optional	Additional notes

{ "event": { "id": "...", "slug": "tech-meetup", "status": "upcoming" } }

Get Event

GET/api/hr/visitor/events/[id]

Get a specific visitor event.

{ "event": { ... visitor event object } }

Update Event

PATCH/api/hr/visitor/events/[id]

Update a visitor event.

Field	Type	Required	Description
`status`	string	Optional	New status (upcoming/ongoing/completed)

{ "event": { ... updated event } }

Delete Event

DELETE/api/hr/visitor/events/[id]

Delete a visitor event.

{ "success": true }

Public: Get Event by Slug

GET/api/public/visitor/event/[slug]

Get visitor event by slug (public, no auth required).

Field	Type	Required	Description
`slug`	string	Required	Event slug (path param)

{ "event": { ... public event info } }

Public: Register for Event

POST/api/public/visitor/register/[slug]

Field	Type	Required	Description
`slug`	string	Required	Event slug (path param)
`visitorName`	string	Required	Your name
`visitorEmail`	string	Required	Your email
`visitorPhone`	string	Optional	Your phone
`purpose`	string	Optional	Visit purpose

{ "pass": { "id": "...", "status": "pending", "identityCode": "VIS789" } }

Visitors

Get All Passes

Create Pass

Get Pass

Update Pass

Get Events

Create Event

Get Event

Update Event

Delete Event

Public: Get Event by Slug

Public: Register for Event

Loading FlowZen

Visitors

Get All Passes

Create Pass

Get Pass

Update Pass

Get Events

Create Event

Get Event

Update Event

Delete Event

Public: Get Event by Slug

Public: Register for Event