Retrieve a List of Invitees

Get Invitees

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

This endpoint allows you to get a list of invitees

Query Parameters

Name
Type
Description

limit

number

The number of invitees you want to retrieve Default: 500 - Min: 1 - Max: 2000

offset

number

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

queryKey

string

Query by any field in the Invitee queryable fields table 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

{
    "invitees": [
        {
            "type":"invitee",
            "id":"01f9a209-644d-4c53-9207-26a304f51a1e",
            "expectedAt":"2019-09-04T14:00:00-03:00",
            "status":"confirmed",
            "lang":"pt-BR",
            "name":"Mateus Schmidt",
            "host": {
                "type":"host",
                "id":"142e81feb92c0a66ee70fd7f4e57a28d",
                "email":"[email protected]",
                "name":"Alisson Enz Rossi",
                "position":"CTO",
                "sector":"IT",
                "phone":"(43) 99982-0420",
                "countryCode":"+55"
            },
            "phone":"(43) 9 9999-9999",
            "email":"[email protected]",
            "company":"W3lcome",
            "customFields":[{
                "id":"IduZUQEh3",
                "name":"Qual sua idade?",
                "type":"Text",
                "value":"26"
            }],
            "notes":"",
            "requiresAuthorization":false
        },
        {
            ...
        }
    ],
    "size": 10
}

Queryable Fields

queryKey

Description

expectedAt

name

String

hostId

String

hostName

String

phone

String

cpf

String

rg

String

document

String

email

String

address

String

company

String

position

String

sector

String

cardNumber

Number?

status

String [confirmed|arrived|canceled]

Last updated

Was this helpful?