Skip to main content
GET
List the companies linked to a building

Authorizations

Authorization
string
header
required

API key gab_live_… or OAuth access token gat_….

Path Parameters

id
string
required

BDNB building id (batiment_groupe_id). Example: "bdnb-bg-CJ69-HW8G-PTTG".

Maximum string length: 40
Pattern: ^bdnb-[a-z]{2,4}-[A-Za-z0-9]{4}(-[A-Za-z0-9]{4})*$

Query Parameters

cursor
string

Cursor returned in meta.page.next_cursor by the previous page. Keep the same filters; the page size is the one of the first page.

Maximum string length: 300
limit
integer
default:20

Results per page, 1 to 100. Default 20.

Required range: 1 <= x <= 100

Response

OK

data
object[]
required
meta
object
required

Pagination metadata of a list response.