Apontador developers
Sign in

PlaceLists


https://api.apontador.com.br/v2/placeLists

Method: GET

Authorization: You can use your access_token from application or from user, but the application authenticated must be trusted.

Parameters:

  • wt: json(default) or xml, the API accepts this information in the request's header(i.e. "Accept: application/xml" or "Accept: application/json"). So you can use the parameter wt or use Accept header.
  • q: this is the term you are searching(your first filter)
  • fq: (optional) specify filters based in some fields. For more than one filter you can either use several fq parameters or use the operator AND (in upper case)
  • fl: (optional) specify the fields that will be returned for each result
  • sort: (optional) the default is relevance, you can choose distance or name desc
  • rows: (optional) the default is 10 and maximum 50
  • start: (optional) the default is 0, it's used for pagination
curl -X GET -H "Accept: application/json" -H "Authorization: Bearer 9fa0d35a-274f-4ddb-ae55-72bf014ca6dc" "https://api.apontador.com.br/v2/placeLists/?q=id:4&fq=addresses.address.state:SP&fl=id,name,categories,type,featured,published,vanityName,addresses"

If successful, this call will return:

{
    "placeListResults": {
        "header": {
            "found": 1, 
            "rows": 1, 
            "start": 0
        }, 
        "placeLists": [
            {
                "addresses": [
                    {
                        "city": "Campo Grande", 
                        "state": "DF"
                    }, 
                    {
                        "city": "Juiz De Fora", 
                        "state": "PI"
                    }
                ], 
                "categories": [
                    {
                        "id": "44", 
                        "link": {
                            "rel": "self", 
                            "uri": "http://127.0.0.1:8080/v2/categories/44"
                        }, 
                        "name": "Bancos", 
                        "subcategory": {
                            "id": "38105", 
                            "name": "Financeiras"
                        }
                    }
                ], 
                "featured": false, 
                "id": "4", 
                "link": {
                    "rel": "self", 
                    "uri": "http://127.0.0.1:8080/v2/placeLists/4"
                }, 
                "name": "lista agiplan", 
                "published": true, 
                "type": "MARCAS", 
                "vanityName": "lista-agiplan"
            }
        ]
    }
}