W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • Get Visits
  • Queryable fields

Was this helpful?

  1. Visit

Retrieve a List of Visits

Get Visits

GET https://api.w3lcome.com/v1/visits

This endpoint allows you to get a list of visits

Query Parameters

Name
Type
Description

limit

number

The number of visits you want to retrieve Default: 500 - Min: 1 - Max: 1000

offset

number

The offset from the first visit. Used to paginate. Default: 0 - Min: 0 - Max: ∞

queryKey

string

Query by any queryable field in the visit object. Default: none

queryOp

string

Add the type of the query. Default: none Accepted values: < <= == > >=

queryValue

string

Insert the value you want to query. Default: none

Headers

Name
Type
Description

Content-Type

string

application/JSON

Authentication

string

Basic token

{
    "visits": [
        {
            "id": "43d2895a-6785-4442-b065-d4c80d7825c8",
            "checkinAt": "2019-07-09T08:02:17-03:00",
            "checkoutAt": "2019-07-09T08:03:12-03:00",
            "isInsideCompany": false,
            "type": "visit",
            "name": "Alisson Enz",
            "company": "W3lcome",
            "host": {
                "id": "b98ff2895de825dec050af67d57a23e1",
                "name": "Gabriel Gratival",
                "email": "gabriel@w3lcome.com",
                "type": "host",
            },
            "pictureUrl": "https://firebasestorage.googleapis.com/v0/b/w3lcome-cbcbb.appspot.com/o/AlissonEnz.jpg?alt=media&token=e2f80260-fc3e-417d-b3ad-572513cf8e18",
            "phone": "(43) 9 9982-0420",
            "email": "alisson@w3lcome.com",
            "customFields": [
                {
                    "id": "aqg-QM4xL",
                    "name": "Do you want to receive promotional emails?",
                    "type": "Dropdown",
                    "value": "Yes"
                }
            ],
            "authorizationStatus": "allowed",
            "notes": "He forgot his id"
        },
        {
            ...
        }
    ],
    "size": 10
}
{
    "type": "INVALID_QUERY_OPERATOR"
}

Queryable fields

Field

Description

checkinAt

checkoutAt

isInsideCompany

Bool

name

String

hostId

String

hostName

String

phone

String

cpf

String

rg

String

document

String

email

String

address

String

company

String

position

String

sector

String

authorizationStatus

String [waiting|allowed|denied]

PreviousRetrieve a VisitNextChange Visit Status

Last updated 4 years ago

Was this helpful?

Unix timestamp
Unix timestamp