Get locations at a building

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieves every Veridion business location associated with a building, as a paginated list.

Run in Postman



When to use it

To see the occupants of a shared building. When an address resolves to a building with several businesses and none could be isolated, the resolver reports a shared building outcome and provides linked_reference.building_id along with the occupant count. This endpoint returns the occupants themselves.

To see who shares a site with a business you resolved. A returned location carries result.building.building_id, so you do not need a shared building outcome to use this endpoint. Resolve one address, confirm the business you care about, then widen to everything sharing the structure.

👍

Shared site exposure

This second pattern is what supports post event claims aggregation, catastrophe risk analysis, and concentration risk assessment. Two critical suppliers in the same building, or an insured sharing a structure with a high hazard operation, are invisible at the address level alone.

Results Pagination

Results are paginated using the same cursor based mechanism as other Veridion APIs. See the Pagination section for the parameters and tokens.

Successful response

A successful request returns 200 OK with a paginated list of location objects in result.

Each item is a location object, identical in shape to a resolved location, with one difference: the nested building object is omitted, because the building is already identified by the request.

📖

Response fields

For a comprehensive list of all data points returned on a location, see the Response fields and types page.

Error responses

  • 404 Not Found, if no building exists for the given ID.
  • other standard HTTP error responses, detailed in the Response codes section.

Any error response follows a specific structure. Please see the Error response format section for more details.


Path Params
string
required

The Veridion ID of the building.

Query Params
integer
Defaults to 100

Number of results to be returned per page. Default value: 100, Maximum value: 500.

string

Cursor returned by a previous call as next_cursor. Bound to the query that produced it. Opaque string (<=1024)

integer

Optional cap on the total number of occupants returned across the pagination session. Integer value (1 - 10000).

Headers
string
required

Your individual OAuth Bearer token (e.g. Authorization: Bearer <your_access_token>).

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json