category.md

Category/Collection APIs

Resource path param: /category

APIs

METHOD	URL	AUTH	USAGE
GET	/category/list-by/city	no	List all categories by city.

GET /category/list-by/city

List all categories by city.

Request

MODE	KEY	TYPE	OPTIONAL	DESCRIPTION
QUERY	cityCode	string	no	The city code. Eg: NEW_YORK, DUBAI
QUERY	offset	string	yes	The offset for pagination. Ref: Pagination - Request Params
QUERY	limit	int	yes	The limit for pagination. Ref: Pagination - Request Params

Response

Object: category

Response Example

{
	"items": [
		{
			"id": "123",
			"name": "Broadway",
			"cityCode": "NEW_YORK",
			"canonicalUrl": "https://www.headout.com/category/24/broadway"
		}
	],
	"nextUrl": "https://www.headout.com/api/public/v1/category/list-by/city?cityCode=NEW_YORK,offset=21,limit=20",
	"prevUrl": "https://www.headout.com/api/public/v1/category/list-by/city?cityCode=NEW_YORK,offset=0,limit=20",
	"total": 100,
	"nextOffset": 21
}