Get Facility entities.

GET/api/facilities/

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.facilities.list({
  organization: 0,
});

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "facilitySpecification": {
      "id": 0,
      "type": "type",
      "name": "name",
      "locale": "locale"
    }
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

categorynumberoptional
localityCategorynumberoptional
detailsbooleanoptional
Default: false
organizationnumberrequired
accommodationnumberoptional

Returns

Array of Facility

Schema shown for 200 · application/json

idnumber
facilitySpecificationone of 1 variantsoptional
Show 1 variant
- FacilitySpecification
  Show 4 properties
  - idnumber
  - typestring
  - namestring
  - localestring