Retrieve a List of Hosts

Get Hosts

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

This endpoint allows you to get a list of host

Query Parameters

Name	Type	Description
limit	number	The number of hosts you want to retrieve Default: 500 - Min: 1 - Max: 1000
offset	number	The offset from the first host. Used to paginate. Default: 0 - Min: 0 - Max: ∞
queryKey	string	Query by any field in the Host 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

200 Success

{
    "hosts": [
        {
            "id": "5d13bad4ae9c50948f6edd67a16d6936",
            "email": "[e-mail]",
            "name": "Alisson Enz Rossi",
            "isActive": true,
            "pictureUrl": "",
            "position": "CTO",
            "sector": "IT",
            "phone": "(43) 9 9982-0420",
            "countryCode": "+55",
            "isPhoneValid": true,
            "company": "W3lcome",
            "message": "",
            "role": "admin"
        },
        {
            ...
        }
    ],
    "size": 2
}

404 Error

{
    "type": "INVALID_QUERY_OPERATOR"
}