Skip to main content

Quickstart

Make your first deployment.

Five steps from sandbox access to a tracked device deployment, with lifecycle events flowing back into your product.

Step 1 — Get sandbox access

Use the sandbox to explore the GroWrk lifecycle model without triggering real device operations. Sandbox credentials are issued by the GroWrk team after a short integration review — they are not generated automatically.

Request Sandbox Access

Step 2 — Authenticate

Keep the key server-side and export it into your environment. Requests are authenticated with the key on every call.

Shell
export GROWRK_API_KEY="grk_sk_..."

See Authentication for key types, scopes, and rotation.

Step 3 — Create an employee

Every physical operation is anchored to a person. Create the employee, or reference one you have already synchronized.

POST /v4/employees
curl https://ai.growrk.com/v4/employees \
  -X POST \
  -H "X-API-KEY: $GROWRK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Ana",
    "last_name": "Duarte",
    "email": "ana@example.com",
    "country": "SG"
  }'

Step 4 — Create a deployment

A deployment order tells GroWrk to source, configure, and deliver a device to that employee in their country.

POST /v4/orders
curl https://ai.growrk.com/v4/orders \
  -X POST \
  -H "X-API-KEY: $GROWRK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "deployment",
    "employee_id": "emp_23981",
    "country": "SG",
    "start_date": "2026-09-01"
  }'

Example payloads are illustrative. Refer to your production API specification for finalized fields and schemas.

Step 5 — Receive lifecycle events

The response confirms the operation was accepted. The outcome arrives as events as the physical work progresses.

Representative lifecycle events
deployment.created
device.sourced
shipment.created
shipment.in_transit
shipment.delivered
asset.assigned

In production, these events represent real operational activity occurring through the GroWrk network — hardware sourced, configured, shipped, cleared, and handed to a person.

  • Store the order identifier and update your record as each event arrives.
  • Handle duplicate and out-of-order deliveries.
  • Exercise exception events, not only the happy path.

Continue with Webhooks & lifecycle events or Explore API Reference.

Ready to build against the GroWrk lifecycle?

Sandbox credentials are issued by the GroWrk team after a short integration review.