Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Visitors

Get visitor

Get visitor by id

Required scopes: flex.community.visitors.read

get/api/v2/organizations/{orgSlug}/visitors/{visitorId}

Path parameters

visitorIdstring required

visitor id

orgSlugstring required

organization slug

Response

_idstring

The _id of the visitor.

namestring

The full name of the visitor.

emailstring

The email address of the visitor.

phonestring

The phone number of the visitor.

descriptionstring

Description of the visitor.

memberstring

Reference to the member that the visitor is visiting.

companystring

Reference to the company that the visitor is visiting.

type'preregistration' | 'reception'

The type of the visitor. Can be one of the following - reception, preregistration.

Example response

{
  "_id": "603dfbc260f4054084125d39",
  "name": "John Doe",
  "email": "johnDoe@email.com",
  "phone": "1234567890",
  "description": "John Doe is visiting the office for a meeting.",
  "member": "603dfbc260f4054084125d38",
  "company": "603dfbc260f4054084125d34"
}