---
title: "Get visitors"
method: GET
path: "/api/v2/organizations/{orgSlug}/visitors"
tags: ["Visitors"]
---

# Get visitors

`GET /api/v2/organizations/{orgSlug}/visitors`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/visitors`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.community.visitors.read`

Retrieve all visitors in the organization 

 Required scopes: `flex.community.visitors.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `name` string
- `email` string
- `type` 'preregistration' | 'reception': The type of the visitor. Can be one of the following - reception, preregistration.
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` VisitorResultDto[]
    - `_id` string: The _id of the visitor.
    - `name` string: The full name of the visitor.
    - `email` string: The email address of the visitor.
    - `phone` string: The phone number of the visitor.
    - `description` string: Description of the visitor.
    - `member` string: Reference to the member that the visitor is visiting.
    - `company` string: 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.

---

[API](https://skmtc.dev/officernd/apis/community-api.md) - [All operations](https://skmtc.dev/officernd/apis/community-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/community-api/revisions/dad1b7912165?raw)