Establishments
List establishments
Retrieve a list of establishments.
GET
/
organization
/
structure
/
api
/
establishments
Query Parameters
id
integer[]
Comma-separated list of establishment IDs.
legalUnitId
integer[]
ID(s) of the legal-unit(s) establishments must belong to.
search
string
Search based on the establishment name.
isArchived
enum<string>
default: falseFilter out establishments based on their archival status.
By default, archived establishments are not returned.
To return both archived and non-archived establishments, use ?isArchived=true,false
Available options:
true
, false
, true,false
page
default: 1
Page index (int - starts at 1) or cursor (string)
limit
integer
default: 10Page size.
Required range:
0 < x < 100
fields.root
enum<string>[]
Include prev and next pages cursors, as well as the number of all items across all pages (count).
Available options:
prev
, next
, count
Response
200 - application/json
items
object[]
prev
string | null
Cursor of the previous page (used with the ?page={{cursor}} query parameter).
next
string | null
Cursor of the next page (used with the ?page={{cursor}} query parameter).
Was this page helpful?