Retrieve a List of Hosts

get
Get Hosts

https://api.w3lcome.com/v1/hosts
This endpoint allows you to get a list of host
Request
Response
Headers
Content-Type
required
string
application/json
Authentication
required
string
Basic token
Query Parameters
limit
optional
number
The number of hosts you want to retrieve Default: 500 - Min: 1 - Max: 1000
offset
optional
number
The offset from the first host. Used to paginate. Default: 0 - Min: 0 - Max: ∞
queryKey
optional
string
Query by any field in the Host object. Default: none
queryOp
optional
string
Add the type of the query. Default: none Accepted values: < <= == > >=
queryValue
optional
string
Insert the value you want to query. Default: none
200: OK
Success
{
"hosts": [
{
"id": "5d13bad4ae9c50948f6edd67a16d6936",
"email": "alisson@w3lcome.com",
"name": "Alisson Enz Rossi",
"isActive": true,
"pictureUrl": "",
"position": "CTO",
"sector": "IT",
"phone": "(43) 9 9982-0420",
"countryCode": "+55",
"isPhoneValid": true,
"company": "W3lcome",
"message": ""
},
{
...
}
],
"size": 2
}
404: Not Found
Error
{
"type": "INVALID_QUERY_OPERATOR"
}