List Sandboxes

Beta

GET/v1/core/sandboxes

This endpoint is idempotent. Learn more

Returns a paginated list of the sandboxes owned by your production account, newest first.

The q search term matches the sandbox name. Sandboxes cannot be listed while acting in a sandbox.

Permissions requiredValues:sandboxes:read

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

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:owner_account

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of sandbox

Resources in this page.

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 List Sandboxes

List Sandboxes

import OpenMRP from '@openmrp/sdk';

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

const listSandbox = await client.core.sandboxes.list();

console.log(listSandbox.data);

import OpenMRP from '@openmrp/sdk';

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

const listSandbox = await client.core.sandboxes.list();

console.log(listSandbox.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/core/sandboxes?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.kXKAISCnBjRSQgFnd0I7qTeh0r-BDb_Nuc5YPrCvj9U",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/core/sandboxes?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.kXKAISCnBjRSQgFnd0I7qTeh0r-BDb_Nuc5YPrCvj9U",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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"
    }
  ]
}

List Sandboxes

Authorization

Query Parameters

Returns

Responses