Docs
V2 APINeighborhood Categories

List neighborhood categories

Paginated, ordered by sort_order then name unless `sort` is given.

GET/api/v2/neighborhood-categories

Paginated, ordered by sort_order then name unless sort is given.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
per_page?integer
Range1 <= value <= 200
Default15
name?string

Case-insensitive substring match.

sort?string

Value in

  • "name"
  • "-name"
  • "sort_order"
  • "-sort_order"
  • "created_at"
  • "-created_at"
  • "updated_at"
  • "-updated_at"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/neighborhood-categories"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "color": "string",      "types": [        "string"      ],      "sort_order": 0,      "places_count": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "page": 0,        "active": true      }    ],    "path": "string",    "per_page": 200,    "to": 0,    "total": 0  }}

Get social profiles GET

The property's Instagram profile and, for a connection using the Facebook-Login flavor, its linked Facebook Page, as published. Each side has a `status`, so "not connected" and "the API failed" are never reported as missing information.

Create neighborhood category POST

Next Page