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

200 Success

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

404 Error

{
    "type": "INVALID_QUERY_OPERATOR"
}