FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Item Category
  • 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. Item Category

Create a new item category

POST
/v1/item-categories
Creates a new item category. Optionally nest it under a parent category by providing a non-empty parentId. ChildTreeLevel and FullName are computed server-side.

Request

Authorization
or
Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Category created successfully
Bodyapplication/json

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/item-categories' \
--header 'Content-Type: application/json' \
--data '{
    "name": "HVAC",
    "active": true,
    "imageUrl": "https://cdn.example.com/categories/hvac.png",
    "parentId": "00000000-0000-0000-0000-000000000000"
}'
Response Response Example
201 - response
{
    "data": {
        "categoryId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "createdAt": "2026-05-15T14:30:00Z"
    }
}
Modified at 2026-05-21 10:40:18
Previous
Retrieve item category by id.
Next
Partially update an item category
Built with