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

Was this helpful?

  1. Blocked list

Retrieve a List of People from the Blocked List

Get people

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

This endpoint allows you to get a list of people from the blocked list

Query Parameters

Name
Type
Description

limit

number

The number of people you want to retrieve from the list. Default: 500 - Min: 1 - Max: 1000

offset

number

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

queryKey

string

Query by any field in the blocked list 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

{
    "blacklist": [
        {
            "id": "dc08c9dc-7aaa-4356-8268-f265b91a1624",
            "name": "Alisson Enz Rossi",
            "type": "blacklist",
            "email": "alisson@w3lcome.com",
            "phone": "43999820420",
            "cpf": "99999999999",
            "rg": "11111111"
        },
        {
            ...
        }
    ],
    "size": 2
}
{
    "type": "INVALID_QUERY_OPERATOR"
}

PreviousRetrieve a Person on the Blocked ListNextInsert a Person on the Blocked List

Last updated 4 years ago

Was this helpful?