v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Visitors

Get visitors

Retrieve all visitors in the organization

Required scopes: flex.community.visitors.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by visitor id. Supports both single id values (e.g., _id=66623dc53090242657393910) and array operations (e.g., _id[$in]=66623dc53090242657393910,66623dbf309024265739390a). Note: Multiple values in simple string format (e.g., _id=66623dc53090242657393910,66623dbf309024265739390a) are not allowed - use _id[$in] format instead.

namestring

Example:Visitor 1

Filter by exact visitor name.

emailstring

Example:johnDoe@example.com

Filter by exact visitor email.

type'preregistration' | 'reception'

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

Filter by the type of the visitor.

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_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"
    }
  ]
}