/api/v1/facilities (GET)

GET

/api/v1/facilities

curl --request GET \
  --url https://example.com/api/v1/facilities \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Responses

200

OK

Array<object>

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Array<object>

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "code": "example",
    "facilityType": "example",
    "address": {
      "line1": "example",
      "line2": "example",
      "city": "example",
      "state": "example",
      "postalCode": "example",
      "country": "example"
    },
    "timeZone": "example",
    "locationCodePattern": "example",
    "status": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
]

Array<object>

object

id

required

string format: uuid

name

required

string

code

required

string

facilityType

required

string

address

required

object

line1

required

string

line2

required

string

nullable

city

required

string

state

required

string

nullable

postalCode

required

string

country

required

string

timeZone

required

string

locationCodePattern

required

string

status

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "code": "example",
    "facilityType": "example",
    "address": {
      "line1": "example",
      "line2": "example",
      "city": "example",
      "state": "example",
      "postalCode": "example",
      "country": "example"
    },
    "timeZone": "example",
    "locationCodePattern": "example",
    "status": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
]