Skip to main content

List the buildings of an org

Audience: org-service-account

Only buildings with a postal address are returned, since the others cannot be updated. The list can lag an update by up to a minute.

Request​

GET https://api.mapped.com/v1/accounts/{accountId}/orgs/{orgId}/buildings

Parameters​

NameInRequiredTypeConstraintsDescription
accountIdpathyesstring
orgIdpathyesstring
limitquerynostringpattern ^\d+$
cursorquerynostring

Example​

curl -X GET 'https://api.mapped.com/v1/accounts/{accountId}/orgs/{orgId}/buildings' \
-H 'Authorization: Bearer <token>'

Responses​

200​

Only buildings with a postal address are returned, since the others cannot be updated. The list can lag an update by up to a minute.

See the example above.

400​

limit is not an integer from 1 to 100 (invalid_limit), or cursor is not one this API gave you (invalid_cursor).

Example error code: invalid_limit

{
"code": "invalid_limit",
"error": "limit must be an integer between 1 and 100",
"success": false
}

401​

No valid bearer token: missing_token (no Authorization: Bearer header), invalid_token or token_expired.

Example error code: invalid_token

{
"code": "invalid_token",
"error": "Invalid bearer token",
"success": false
}

403​

Not a credential for this org and account, or not an account-org-level service-account credential. Nothing was read or changed.

Error code: forbidden

{
"code": "forbidden",
"error": "Org does not belong to this account",
"success": false
}

429​

Too many requests; see Retry-After.

Error code: rate_limited

{
"code": "rate_limited",
"error": "Too many requests",
"success": false
}

503​

A check this API depends on is unavailable; retry.

Error code: upstream_unavailable

{
"code": "upstream_unavailable",
"error": "Authorization service unavailable",
"success": false
}

Download OpenAPI spec