1. Visitors
Public API
  • Welcome to the deskbird developer docs
  • Public API
    • Overview
    • Users
      • Lists company users
      • Retrieves a single company user
    • Bookings
      • Lists company bookings
      • Creates a new resource booking
      • Gets a single company booking
      • Updates an existing booking
      • Cancels a booking
      • Checks in to a booking
      • Releases a booking early
    • Groups
      • Lists company user groups
      • Retrieves a single company user group
    • Resources
      • Gets a resource by ID
      • Lists company resources
    • Offices
      • Lists company offices
      • Checks a user into an office
    • Scheduling
      • Lists company scheduling statuses
      • Deletes scheduling statuses by IDs
      • Adds new scheduling statuses for a user
    • Scheduling Options
      • Lists company scheduling options
    • Rooms
      • Lists company rooms
      • Gets a single room
      • Creates a room booking
      • Lists room bookings
      • Gets a single room booking
      • Updates a room booking
      • Checks in to a room booking
      • Cancels a room booking
      • Lists company room bookings
    • Floors
      • Lists company floors
    • Zones
      • Lists company zones
    • Tickets
      • Updates a ticket
    • Sensors
      • Lists company monitors
  • MCP server
    • Overview
    • Authentication
    • Tools reference
  • Sensors
    • Lists company network configurations
  • Visitors
    • Lists company visit types
      GET
    • Lists company visits
      GET
    • Gets a single company visit
      GET
  • Tickets
    • Lists company tickets
    • Gets a single company ticket
    • Lists ticket categories
  • Schemas
    • Provider
    • UserStatus
    • UserIncludeOptions
    • BookingStatus
    • GuestEmbeddedResponse
    • UserEmbeddedResponse
    • ResourceEmbeddedResponse
    • BookingHistoryResponse
    • BookingResponse
    • PaginatedBookingResponse
    • CreateBookingGuestDto
    • CreateBookingDto
    • UpdateBookingDto
    • CheckInDto
    • AddressResponse
    • OpeningHourResponse
    • OpeningHoursResponse
    • OfficeResponse
    • EnvelopedOfficeResponse
    • CheckUserIntoOfficeBody
    • SharedResourceAccessInfoResponse
    • DedicatedResourceAccessInfoResponse
    • EquipmentResponse
    • ResourceResponse
    • ResourceType
    • PaginatedResourceResponse
    • SchedulingOutput
    • UserStatusInput
    • AddUserStatusesInput
    • SchedulingOptionOutput
    • AttendeeResponse
    • RoomBookingResponse
    • PaginatedRoomBookingResponse
    • RoomBookingDetailedResponse
    • AttendeeDto
    • RoomResponse
    • PaginatedRoomResponse
    • CreateRoomBookingDto
    • UpdateRoomBookingDto
    • FloorResponse
    • PaginatedFloorResponse
    • AssignedGroupResponse
    • ZoneResponse
    • PaginatedZoneResponse
    • UpdateTicketDto
    • MonitorState
    • MonitorOfficeResponse
    • MonitorFloorResponse
    • MonitorAreaResponse
    • MonitorDeskResponse
    • MonitorMappingResponse
    • MonitorResponse
    • PaginatedMonitorResponse
    • NetworkConflictSignal
    • NetworkConflictResponse
    • NetworkResponse
    • PaginatedNetworkResponse
    • TicketCategoryReferenceResponse
    • VisitTypeResponse
    • TicketUserResponse
    • EnvelopedVisitTypeResponse
    • TicketCustomFieldResponse
    • TicketAttachmentResponse
    • TicketResponse
    • PaginatedTicketResponse
    • TicketCommentResponse
    • TicketDetailsResponse
    • TicketCategoryCustomFieldResponse
    • TicketCategoryResponse
    • EnvelopedTicketCategoryResponse
    • VisitTypeReferenceResponse
    • VisitHostResponse
    • VisitorResponse
    • VisitResponse
    • PaginatedVisitResponse
  1. Visitors

Gets a single company visit

GET
/visitors/visits/{visitId}
Retrieves one visit with its visitors, their check-in state, the host and the visit type. Cancelled visits are returned with status cancelled. A visit of another company is reported as not found. Requires the Visitors module.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://connect.deskbird.com/visitors/visits/' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
The requested visit
Bodyapplication/json

Example
{
    "id": "b1eebc99-9c0b-4ef8-bb6d-6bb9bd380b01",
    "officeId": "a1eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "visitType": {
        "id": "f1eebc99-9c0b-4ef8-bb6d-6bb9bd380f01",
        "name": "Business"
    },
    "name": "Quarterly review",
    "status": "scheduled",
    "anonymized": false,
    "startTime": "2026-06-24T09:00:00.000Z",
    "endTime": "2026-06-24T10:00:00.000Z",
    "host": {
        "id": "d1eebc99-9c0b-4ef8-bb6d-6bb9bd380d01",
        "email": "john.host@deskbird.com",
        "firstName": "John",
        "lastName": "Host"
    },
    "visitors": [
        {
            "id": "c1eebc99-9c0b-4ef8-bb6d-6bb9bd380c01",
            "userId": null,
            "email": "jane.visitor@example.com",
            "firstName": "Jane",
            "lastName": "Visitor",
            "companyName": "Example Ltd",
            "status": "checkedIn",
            "checkedInAt": "2026-06-24T09:02:00.000Z",
            "checkedOutAt": null,
            "checkedInSource": "webapp",
            "anonymized": false
        }
    ],
    "completedAt": null,
    "cancelledAt": null,
    "createdAt": "2026-06-01T08:00:00.000Z",
    "updatedAt": "2026-06-24T09:02:00.000Z",
    "createdByUserId": "d1eebc99-9c0b-4ef8-bb6d-6bb9bd380d01"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Previous
Lists company visits
Next
Lists company tickets
Built with