---
updatedAt: 2025-12-25T23:13:37.000Z
agentTools:
  projectIndex: https://integrate.route4me.com/llms.txt
---

# List Facilities

Get facilities. This endpoint retrieves detailed information with record details.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Facility API",
    "description": "Facility API",
    "contact": {
      "name": "Route4Me",
      "url": "docs.route4me.com",
      "email": "support@route4me.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "v5.0"
  },
  "servers": [
    {
      "url": "https://wh.route4me.com/modules/",
      "description": "Route4Me Staging API V5"
    }
  ],
  "paths": {
    "/api/v5.0/facilities": {
      "get": {
        "tags": [
          "Facilities"
        ],
        "summary": "Get facilities",
        "description": "Get facilities",
        "operationId": "1cee252b20740489848e8e84cbd878ed",
        "parameters": [
          {
            "name": "search_query",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Parameter: search_query"
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Parameter: page"
          },
          {
            "name": "per_page",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Parameter: per_page"
          },
          {
            "name": "filters",
            "in": "query",
            "example": "filters[status]=1&filters[status]=2",
            "description": "Parameter: filters",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order_by",
            "in": "query",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "example": "{\"field_name\": \"sort_direction\"}"
              }
            },
            "description": "Parameter: order_by"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacilitiesPaginateResource"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FacilitiesPaginateResource": {
        "description": "Paginated response",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FacilityResource"
            }
          },
          "total": {
            "type": "integer"
          },
          "meta": {
            "properties": {
              "current_page": {
                "type": "integer"
              },
              "from": {
                "type": "integer"
              },
              "last_page": {
                "type": "integer"
              },
              "path": {
                "type": "string"
              },
              "per_page": {
                "type": "integer"
              },
              "to": {
                "type": "integer"
              },
              "total": {
                "type": "integer"
              },
              "links": {
                "description": "Pages links",
                "type": "array",
                "items": {
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "active": {
                      "type": "boolean"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "type": "object"
          },
          "links": {
            "properties": {
              "first": {
                "description": "First page link",
                "type": "string"
              },
              "last": {
                "description": "Last page link",
                "type": "string"
              },
              "prev": {
                "description": "Previous page link",
                "type": "string"
              },
              "next": {
                "description": "Next page link",
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "FacilityResource": {
        "description": "successful operation",
        "properties": {
          "facility_id": {
            "type": "string",
            "format": "hex32"
          },
          "coordinates": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "status": {
            "type": "integer"
          },
          "facility_alias": {
            "type": "string"
          },
          "facility_types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FacilityTypeRelationResource"
            }
          },
          "custom_data": {
            "description": "Custom data key-value map.",
            "type": "object",
            "example": {
              "key_1": "val_1",
              "key_2": "val_2"
            },
            "nullable": true,
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "type": "object"
      },
      "FacilityTypeRelationResource": {
        "description": "successful operation",
        "properties": {
          "facility_type_id": {
            "type": "integer"
          },
          "facility_type_alias": {
            "type": "string"
          },
          "is_default": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ValidationErrorResponse": {
        "properties": {
          "status": {
            "type": "boolean"
          },
          "code": {
            "type": "integer"
          },
          "exit_code": {
            "type": "integer"
          },
          "error": {
            "type": "string"
          },
          "messages": {
            "properties": {
              "validated_property": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "type": "object"
          },
          "validation_errors": {
            "properties": {
              "validated_property": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "security": [
    {
      "ApiKeyQueryAuth": []
    },
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Facilities",
      "description": "Facilities"
    }
  ]
}
```