Skip to content

Fetch All Visitors

GET
/api/v1/developer/visitors

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Query Parameters

status
Type
integer
Example1
Minimum
1
Maximum
6
keyword
Type
string
Example"John"
page_num
Type
string
Example"1"
page_size
Type
string
Example"25"
expand[]
Type
string
Example"access_policy"

Responses

Visitors retrieved successfully

application/json
JSON
{
  
"code": "string",
  
"msg": "string",
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"first_name": "string",
  
  
  
"last_name": "string",
  
  
  
"status": "string",
  
  
  
"inviter_id": "string",
  
  
  
"inviter_name": "string",
  
  
  
"mobile_phone": "string",
  
  
  
"remarks": "string",
  
  
  
"email": "string",
  
  
  
"visitor_company": "string",
  
  
  
"visit_reason": "string",
  
  
  
"start_time": 0,
  
  
  
"end_time": 0,
  
  
  
"nfc_cards": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"token": "string",
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"pin_code": {
  
  
  
  
"token": "string"
  
  
  
},
  
  
  
"schedule_id": "string",
  
  
  
"schedule": {
  
  
  
  
"name": "string",
  
  
  
  
"type": "string",
  
  
  
  
"week_schedule": {
  
  
  
  
  
"sunday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"monday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"tuesday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"wednesday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"thursday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"friday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"saturday": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"start_time": "00:00:00",
  
  
  
  
  
  
  
"end_time": "23:59:59"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
},
  
  
  
"resources": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"license_plates": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"credential": "string",
  
  
  
  
  
"credential_type": "license",
  
  
  
  
  
"credential_status": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"pagination": {
  
  
"page_num": 0,
  
  
"page_size": 0,
  
  
"total": 0
  
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI