FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Warehouse
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Retrieve customers by phone, email, or first name
      GET
    • Retrieve customer details by ID
      GET
    • Retrieve customers based on address details.
      GET
  • Item Category
    • Retrieve list of item categories
      GET
    • Retrieve item category by id.
      GET
    • Create a new item category
      POST
    • Partially update an item category
      PATCH
  • Item
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Retrieve an inventory item by ID
      GET
    • Creates a new inventory item
      POST
    • Updates an existing inventory item
      PATCH
  • Warehouse
    • Create a new warehouse
      POST
    • Retrieve a paginated list of warehouses
      GET
    • Update an existing warehouse
      PATCH
    • Retrieve a warehouse by ID
      GET
  • Employee
    • Retrieve a paginated list of employees
      GET
    • Retrieve an employee by ID
      GET
  • Company
    • Retrieve company name by ID
      GET
  • WorkOrder
    • Retrieve a work order by ID
  • Invoice
    • Retrieve an invoice by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Rotate the HMAC signing secret for the registered webhook.
    • Delete the registered webhook for the authenticated account.
  1. Warehouse

Retrieve a paginated list of warehouses

GET
/v1/warehouses
Retrieves a paginated list of warehouses. Supports filtering by name, active status, and sorting.

Request

Query Params

Responses

🟢200
application/json
Warehouses retrieved successfully
Bodyapplication/json

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/warehouses?offset=undefined&limit=undefined&name=undefined&active=undefined&sort=undefined'
Response Response Example
200 - response
{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "warehouseId": "a1b2c3d4-5e6f-47a8-9b0c-d1e2f3a4b5c6",
            "name": "Central Warehouse",
            "address1": "123 Main St",
            "address2": "Unit 5",
            "city": "Austin",
            "state": "TX",
            "zipCode": "78701",
            "description": "Primary distribution center",
            "active": true
        },
        {
            "warehouseId": "d4c3b2a1-6f5e-84a7-0c9b-6e5f4d3c2b1a",
            "name": "North Warehouse",
            "address1": "456 North Ave",
            "address2": "",
            "city": "Dallas",
            "state": "TX",
            "zipCode": "75201",
            "description": "Overflow storage",
            "active": false
        }
    ]
}
Modified at 2026-05-21 10:40:18
Previous
Create a new warehouse
Next
Update an existing warehouse
Built with