v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Visits

Get visits

Retrieve all visits in the organization

Required scopes: flex.community.visits.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Example:603dfbc260f4054084125d39

Filter by visit id.

visitorstring

Example:603dfbc260f4054084125d39

Filter by visitor id.

memberstring

Example:603dfbc260f4054084125d39

Filter by member id.

locationstring

Example:603dfbc260f4054084125d39

Filter by location id.

startstring

Example:start[$gte]=2024-10-31T13:00:00Z

Support date comparison filters: $gt, $gte, $lt, $lte

endstring

Example:end[$gte]=2024-10-31T13:00:00Z

Support date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "603dfbc260f4054084125d39",
      "member": "603dfbc260f4054084125d38",
      "visitor": "603dfbc260f4054084125d34",
      "location": "603dfbc260f4054084125d36",
      "start": "2022-02-07T10:03:33.169Z",
      "end": "2022-02-07T10:03:33.169Z",
      "receptionFlow": "603dfbc260f4054084125d34"
    }
  ]
}