STstreet
Areas

Get all Areas

This endpoint retrieves multiple paginated areas along with meta and pagination information.

get/areas

Request

Query parameters

filter[trashed]'with' | 'only'

Optionally return result WITH deleted results or return ONLY deleted results.

page[size]number
Example:25

Set the number of results per page.

page[number]number
Example:3

Set the page number.

Response

OK.

Example response

{
  "links": {
    "self": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=2",
    "first": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "next": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "prev": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=3",
    "last": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=9"
  },
  "meta": {
    "pagination": {
      "total": 226,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 23
    }
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.