List Locations
GET {{baseUrl}}/locations?page[size]=100&page[number]=0&include=<string>&filter[type]=<string>&filter[isPartOf.data.type]=<string>
List Locations
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[size] | number | The numbers of items to return | |
page[number] | number | The page number (how many pages to skip) | |
include | string | Includes the hasPostalAddress relationship | |
filter[type] | string | Filter by 'type' | |
filter[isPartOf.data.type] | string | Filter by 'type' of isPartOf relationship |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"self":"/locations","next":"/locations?page[number]=1"},"data":[{"attributes":{"label":"Aspern Smart City Campus","timeZone":"Europe/Zurich","description":"A properly organized location","externalId":"IfcGuid:1234","tags":{"consequat_6":["exercitation"],"eiusmod3":["id ut tempor pariatur officia"],"dolor79":["aute nisi consequat eiusmod dolor"],"magna_6b":["nisi"]},"geoLocation":{"geometry":{"type":"Point","coordinates":[8.48281,47.19717]}},"geoArea":{"geometry":{"type":"Polygon","coordinates":[[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]]}},"primaryContact":{"name":"Marla Pfahl","email":"marla.pfahl@example.com","phone":"+41 41 234 56 78"}},"id":"43997b3e-fe5a-4053-ab90-ed218faa164f","type":"Campus","relationships":{"hasPostalAddress":{"data":{"id":"05085306-9c1d-4cee-b92a-04c07e4b1945","type":"Address"}}},"meta":{"createdAt":"1967-04-29T09:05:08.486Z","updatedAt":"1993-12-22T21:43:33.036Z","createdBy":"adsf","updatedBy":"adsf"}},{"attributes":{"label":"Aspern Smart City Campus","timeZone":"Europe/Zurich","description":"A properly organized location","externalId":"IfcGuid:1234","tags":{"consequat_597":["dolore adipisicing magna minim enim"],"culpa_488":["Lorem esse veniam tempor"],"dolore_9":["ut irure"]},"geoLocation":{"geometry":{"type":"Point","coordinates":[8.48281,47.19717]}},"geoArea":{"geometry":{"type":"Polygon","coordinates":[[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]]}},"primaryContact":{"name":"Marla Pfahl","email":"marla.pfahl@example.com","phone":"+41 41 234 56 78"}},"id":"43997b3e-fe5a-4053-ab90-ed218faa164f","type":"Campus","relationships":{"hasPostalAddress":{"data":{"id":"05085306-9c1d-4cee-b92a-04c07e4b1945","type":"Address"}}},"meta":{"createdAt":"1946-12-31T09:53:52.536Z","updatedAt":"1965-09-10T16:19:01.615Z","createdBy":"adsf","updatedBy":"adsf"}}],"included":[{"attributes":{"countryCode":"AUT","countryName":"Austria","continentCode":"EU","continentName":"Europe","locality":"Vienna","region":"Styria","postalCode":"1010","street":"Opernring 3"},"id":"05085306-9c1d-4cee-b92a-04c07e4b1945","type":"Address","meta":{"createdAt":"2007-01-02T19:36:06.804Z","updatedAt":"1989-06-24T02:37:39.187Z","createdBy":"adsf","updatedBy":"adsf"}},{"attributes":{"countryCode":"AUT","countryName":"Austria","continentCode":"EU","continentName":"Europe","locality":"Vienna","region":"Styria","postalCode":"1010","street":"Opernring 3"},"id":"05085306-9c1d-4cee-b92a-04c07e4b1945","type":"Address","meta":{"createdAt":"2023-09-04T02:13:06.012Z","updatedAt":"2013-05-24T11:05:33.309Z","createdBy":"adsf","updatedBy":"adsf"}}]}