Skip to main content
Sandboxes

List sandbox organisations

GET/v4/config/platform/sandbox-orgs

Lists the sandbox organisations of the organisation, the last updated first. Deleted sandbox organisations are not listed.

  • search: keeps the sandbox organisations whose name or description contains the text (case does not matter).
  • sortOrder: asc puts the oldest update first.
  • offset and limit: page through the list.

An item has no service URLs: get them with Read sandbox organisation.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:sandboxes:read

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • searchstring

    Text to search for. The description of the operation says which fields it searches.

  • sortOrderenum<string>

    Sort order: desc (default, newest first) or asc (oldest first). Any other value is desc.

    Available options:desc,asc

    Default:desc

Response

application/json

The sandbox organisations on the page and the pagination data.

  • sandboxOrgsobject[]

    The sandbox organisations on this page.

  • paginationobject