Retrieve Sandbox

Beta

GET/v1/core/sandboxes/{id}

This endpoint is idempotent. Learn more

Returns a single sandbox by ID.

Only sandboxes owned by your production account are visible; any other sandbox is reported as not found. Sandboxes cannot be retrieved while acting in a sandbox.

Permissions requiredValues:sandboxes:read

The role behind your API key or agent must grant every one of these permissions.

idstring

ID of the sandbox to retrieve.

include[]optional arrayenumValues:owner_account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Sandbox ID.

objectstringenumValues:sandbox

Resource type identifier.

namestring

Display name of the sandbox.

owner_accountaccountExpandablenullable

The production account that owns this sandbox.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this sandbox was created.

updated_atstring (date-time)

When this sandbox was last updated.

Responses

200

Successful response for Retrieve Sandbox

Retrieve Sandbox

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.retrieve('sbac_d8ci32xggml9');

console.log(sandbox.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.retrieve('sbac_d8ci32xggml9');

console.log(sandbox.id);

200 example

{
  "id": "sbac_d8ci32xggml9",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_ykxoradjoeb3",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "sbac_d8ci32xggml9",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_ykxoradjoeb3",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Sandbox

Authorization

Path Parameters

Query Parameters

Returns

Responses