GroWrk for developers

Device lifecycle
infrastructure, built
into your product.

Connect workforce events in your application to real-world device operations through GroWrk.

Quickstart Read the Docs Explore API Reference

POST /v4/orders Copy

POST /v4/orders
X-API-KEY: grk_sk_…
Content-Type: application/json

{
  "type": "deployment",
  "employee_id": "emp_23981",
  "country": "SG"
}

Request → physical execution → event

Your App
GroWrk API
Device Operation
GroWrk Execution
Status / Event
Your App

The loop closes: every request GroWrk executes in the physical world returns to your application as a status change or event.

What you can build

Lifecycle operations
your product can control.

Each of these maps to an operation already exposed by the GroWrk v4 surface — through the API, the CLI, or the MCP server.

Deploy a device

Trigger a deployment order for an employee in a supported market.

POST /v4/orders

Retrieve a device

Start an offboarding or collection order when someone leaves.

POST /v4/orders

Check lifecycle status

Read the current state and full event history of any order.

GET /v4/orders/{id}/history

Track an order

Read shipment tracking and SLA status for in-flight operations.

GET /v4/orders/{id}/tracking

Manage inventory

Search company inventory and devices assigned to an employee.

GET /v4/inventory

Trigger repair or replacement

Place a maintenance or swap order against an existing device.

POST /v4/orders

Initiate end-of-life workflows

Collect devices for storage, redeployment, or responsible disposal.

POST /v4/orders

Quickstart

From access to executed operation.

Six steps from credentials to a device physically delivered, retrieved, or repaired — with your product kept in sync.

01
Get access
Embedded partners receive credentials for the environments agreed during onboarding.
02
Authenticate
API requests are authenticated with your GroWrk API key. The MCP server uses OAuth 2.1.
```
X-API-KEY: grk_sk_…
```
03
Create or reference the employee / asset
Create the person in GroWrk, or reference an existing employee and their assigned devices.
```
POST /v4/employees
GET  /v4/employees/{id}/devices
```
04Illustrative example
Trigger a lifecycle operation
Place the order that maps to your product event — deployment, collection, maintenance, swap.
```
POST /v4/orders

{
  "type": "deployment",
  "employee_id": "emp_23981",
  "country": "SG"
}
```
05
Receive status updates
Read order status, history, tracking, and SLA as GroWrk executes the operation.
```
GET /v4/orders/{id}
GET /v4/orders/{id}/tracking
GET /v4/orders/{id}/sla
```
06Illustrative example
Keep your application synchronized
Persist the returned lifecycle state against your own records so your product stays accurate.
```
{
  "id": "ord_48291",
  "status": "processing",
  "sla": { "expected_days": 7, "late": false }
}
```

Request and response shapes shown for illustration. Partners receive the authoritative reference during onboarding.

Lifecycle event model

One loop: your event in, physical
execution out, event back.

GroWrk is event driven by design. Your application never has to poll a human process.

Your application event

Employee hired
Employee terminated
Device issue
Asset refresh

GroWrk lifecycle request

deployment
offboarding
maintenance
swap

Physical execution

Sourced
Configured
Shipped
Delivered / Collected

Lifecycle event returned

order.created
order.status_changed
shipment.delivered

Capability reference

One capability set. Three surfaces.

Every capability is exposed identically over the v4 REST API, the growrk CLI, and the MCP server for AI agents — backed by one shared execution core, so they never drift.

17: Capabilities
13 read · 4 write: Access
3: Surfaces
ai.growrk.com: Base host

Orders 8 tools · mcp:orders:read · :write

`list_orders`Read

Search & list orders — free-text, status/type filters, sorting, pagination.

GET /v4/ordersgrowrk orders list

`get_order`Read

One order with full hierarchy — parent + sub-orders, device requests, tracking.

GET /v4/orders/{id}growrk orders get <id>

`get_order_history`Read

Full event history — status logs plus a per-device courier + product timeline.

GET /v4/orders/{id}/historygrowrk orders history <id>

`get_tracking`Read

Shipment tracking — GroWrk records merged with live TrackingMore courier data.

GET /v4/orders/{id}/trackinggrowrk orders tracking <id>

`get_order_sla`ReadNew

SLA / delay status — days elapsed vs expected, whether it's late, and why.

GET /v4/orders/{id}/slagrowrk orders sla <id>

`validate_order_constraints`Read

Pre-flight check — can this order type be placed for an employee & their devices.

POST /v4/orders/validategrowrk orders validate

`create_order`Write

Place an order — deployment, offboarding, collection, maintenance, or swap.

POST /v4/ordersgrowrk orders create

`add_power_accessory`Write

Request a replacement charger for a device on an existing order.

POST /v4/orders/{id}/accessoriesgrowrk orders add-accessory <id>

Employees 4 tools · mcp:employees:read · :write

`list_employees`Read

Search & list employees — free-text, status filter, sorting, pagination.

GET /v4/employeesgrowrk employees list

`get_employee`Read

One employee, including their stored delivery address.

GET /v4/employees/{id}growrk employees get <id>

`create_employee`Write

Create an employee record — name + email required.

POST /v4/employeesgrowrk employees create

`update_employee`Write

Update editable fields — name, email, team, department, delivery address.

PATCH /v4/employees/{id}growrk employees update <id>

Inventory & Devices 4 tools · mcp:inventory:read

`search_inventory`Read

Search a company's device inventory — category, country, status, in-stock filters.

GET /v4/inventorygrowrk inventory search

`get_assigned_devices`Read

Devices currently assigned to an employee.

GET /v4/employees/{id}/devicesgrowrk employees devices <id>

`get_device_options`Read

Available device options ranked by spec & availability — for choices & redeployment.

GET /v4/devices/optionsgrowrk devices options

`suggest_alternative_device`Read

Purchasable catalog alternatives for a country, ranked by maker/spec/price.

GET /v4/devices/suggestionsgrowrk devices suggestions

Identity 1 tools · no scope required

`whoami`Read

Your identity & access level — which companies and scopes the key/session carries.

GET /v4/megrowrk me

REST — X-API-KEY: grk_sk_… on https://ai.growrk.com/v4/… · CLI — npm i -g @growrk/cli, then growrk auth login · MCP — POST https://ai.growrk.com/mcp (OAuth 2.1)

Webhooks

The physical world, exposed as events.

Subscribe to lifecycle events so your application always knows what is happening with a device in the real world.

Deployments
Shipments
Retrievals
Inventory
Repairs
ITAD

Deployments · event feed

14:32:04  deployment.created
14:32:08  device.sourced
14:45:21  configuration.started
15:04:49  configuration.completed
15:07:12  shipment.created
18:42:09  shipment.in_transit
09:21:31  shipment.delivered
09:21:34  asset.assigned

Webhook payload Copy

{
  "type": "shipment.delivered",
  "data": {
    "deployment_id": "dep_78219",
    "employee_id": "emp_23981",
    "device_id": "dev_82117",
    "country": "SG"
  }
}

Platform principles

How the platform behaves.

Secure

Scoped access and enterprise controls.

Event driven

Keep lifecycle state synchronized with your product.

Operational

API requests connect to real-world execution.

Global

One integration provides access to supported GroWrk markets.

Architecture

Your product. Our infrastructure.

Physical IT operations exposed through software — your application sends an instruction, GroWrk executes it.

Your product

Employee Created
Employee Terminated
IT Ticket
Admin Request
API Call

GroWrk API

GroWrk orchestration

Procurement
Device Configuration
Warehouses
Couriers
Employee Communication
Retrievals
Repairs
Storage
Redeployment
ITAD

Employee / Device — Anywhere

You shouldn't need to become a
logistics company to offer global IT.

Your product owns the customer experience. GroWrk abstracts the infrastructure required to execute device operations around the world.

Documentation

Everything an integration team needs.

Public documentation covers the integration model, authentication, environments, core resources, API fundamentals, and lifecycle events. Credentials are issued separately.

Start here

Resources

Events & operations

Platform

Developer access

Build before you launch.

Work with the GroWrk team to evaluate integration requirements and developer access. Environments, credentials, and scopes are agreed with your team during onboarding.

Request Sandbox Access Read the Docs

What we scope together

Which lifecycle operations your product triggers
Which markets you need on day one
How lifecycle events flow back into your systems
Access scopes and environments for your team

Build with GroWrk, not around GroWrk.

Embedded partners work directly with the GroWrk team during implementation — integration scoping, technical review of your lifecycle flows, and support through go-live.

Request Sandbox Access

Device lifecycle infrastructure, built into your product.

Lifecycle operations your product can control.

Deploy a device

Retrieve a device

Check lifecycle status

Track an order

Manage inventory

Trigger repair or replacement

Initiate end-of-life workflows

From access to executed operation.

Get access

Authenticate

Create or reference the employee / asset

Trigger a lifecycle operation

Receive status updates

Keep your application synchronized

One loop: your event in, physical execution out, event back.

One capability set. Three surfaces.

Orders 8 tools · mcp:orders:read · :write

list_ordersRead

get_orderRead

get_order_historyRead

get_trackingRead

get_order_slaReadNew

validate_order_constraintsRead

create_orderWrite

add_power_accessoryWrite

Employees 4 tools · mcp:employees:read · :write

list_employeesRead

get_employeeRead

create_employeeWrite

update_employeeWrite

Inventory & Devices 4 tools · mcp:inventory:read

search_inventoryRead

get_assigned_devicesRead

get_device_optionsRead

suggest_alternative_deviceRead

Identity 1 tools · no scope required

whoamiRead

The physical world, exposed as events.

How the platform behaves.

Secure

Event driven

Operational

Global

Your product. Our infrastructure.

You shouldn't need to become a logistics company to offer global IT.

Everything an integration team needs.

Build before you launch.

Build with GroWrk, not around GroWrk.

Device lifecycle
infrastructure, built
into your product.

Lifecycle operations
your product can control.

One loop: your event in, physical
execution out, event back.

`list_orders`Read

`get_order`Read

`get_order_history`Read

`get_tracking`Read

`get_order_sla`ReadNew

`validate_order_constraints`Read

`create_order`Write

`add_power_accessory`Write

`list_employees`Read

`get_employee`Read

`create_employee`Write

`update_employee`Write

`search_inventory`Read

`get_assigned_devices`Read

`get_device_options`Read

`suggest_alternative_device`Read

`whoami`Read

You shouldn't need to become a
logistics company to offer global IT.