Skip to Content
Embed SystemEnd Users

End Users

End users represent your customers who interact with Orderly through your embedded integration. They’re identified by the externalId you provide when creating sessions — this should be your internal user or customer ID.

Automatic Creation

End user records are created automatically when a session is first created for a given externalId. You don’t need to pre-register users.

End User Scoping

All data in the embed system is scoped to end users:

  • Bridges created through embeds are tagged with the end user’s ID
  • Orders synced through those bridges are associated with the end user
  • Shipments linked to those orders inherit the end user association
  • Action requests, alert rules, webhooks, and tracking pages are all scoped per end user

This means each end user only sees their own data, while you retain full org-level access to everything.

Management API

These endpoints require an oh_ API key with the embed:manage scope.

List End Users

GET /api/v1/embed/users?page=1&limit=20
Authorization: Bearer oh_your-api-key

Returns paginated end users with bridge counts:

{
  "data": [
    {
      "id": "uuid",
      "external_id": "customer_123",
      "name": "Acme Corp",
      "email": "acme@example.com",
      "metadata": {},
      "bridge_count": 3,
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-20T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasMore": true
  }
}

Get End User Details

GET /api/v1/embed/users/:id
Authorization: Bearer oh_your-api-key

Returns the end user and their associated bridges.

Delete End User

DELETE /api/embed/users/:id
Authorization: Bearer oh_your-api-key

Deleting an end user:

  • Revokes all their active sessions
  • Disassociates their bridges (sets end_user_id to null)
  • Removes the end user record

Orders and shipments previously associated with the end user are retained.

Metadata

You can store custom data on end users via the metadata field when creating sessions:

{
  "externalId": "customer_123",
  "name": "Acme Corp",
  "metadata": {
    "plan": "enterprise",
    "region": "us-east"
  }
}

Metadata is a free-form JSON object that you can use for your own reference.

SessionsBridge Management