Skip to main content

List sandbox organisations

GET 
/v2/config/sandbox-orgs

Lists the sandbox organisations of the organisation. The service sorts the list by the time of the last update, and it does not list deleted sandbox organisations.

Use the offset and the limit query parameters to page through the list. Use the search query parameter to filter the list, and the sortOrder query parameter to change the sort direction.

The response gives the sandbox organisation records only. To get the OpenID endpoints of one sandbox organisation, read it with GET /config/sandbox-org/{sandboxOrgId}.

Request​

Query Parameters

    offset integerrequired

    Default value: 0

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

    limit integerrequired

    Default value: 10

    Maximum number of records to return per page.

    search stringrequired

    Search term to filter results by

    sortOrder stringrequired

    Possible values: [desc, asc]

    Default value: desc

    Sort order for the returned records (ascending or descending).

Responses​

The service returns the sandbox organisations and the pagination data.

Response Headers
    Schema
      sandboxOrgs object[]required

      The sandbox organisations on the current page.

    • Array [
      • id stringrequired

      Unique identifier of the sandbox organisation

      name stringrequired

      Display name of the sandbox organisation

      description stringrequired

      Human readable description of the sandbox organisation

      openIdDeploymentId stringrequired

      Identifier of the associated OpenID deployment

      status integerrequired

      Status code of the sandbox organisation

      ledgerId integerrequired

      Identifier of the associated ledger

      infrastructureProvider stringrequired

      Name of the infrastructure provider

      version stringrequired

      Version of the sandbox organisation configuration

      role stringrequired

      Role of the sandbox organisation in the ecosystem

      trustAnchor stringrequired

      Trust anchor identifier or DID

      isWalletProvider booleanrequired

      Indicates whether this sandbox organisation acts as a wallet provider

      secureVault integerrequired

      Identifier of the primary secure vault

      secureVaults integer[]nullable

      Identifiers of the secure vaults that the sandbox organisation uses. The field holds null when the sandbox organisation has no secure vault.

      logoImageId string

      Identifier of the logo image. The field is absent when the sandbox organisation has no logo image.

      coverImageId string

      Identifier of the cover image. The field is absent when the sandbox organisation has no cover image.

      logoImageUrl stringrequired

      Public URL for the logo image

      coverImageUrl stringrequired

      Public URL for the cover image

      createdAt integerrequired

      Timestamp when the sandbox organisation was created

      updatedAt integerrequired

      Timestamp when the sandbox organisation was last updated

      isMain booleanrequired

      Indicates whether this is the main organisation

    • ]
      • pagination objectrequired
      currentPage integer

      Current page number

      totalItems integer

      Total number of items available

      totalPages integer

      Total number of pages based on limit

      limit integer

      Number of items per page

      hasPrevious boolean

      Indicates if there's a previous page

      hasNext boolean

      Indicates if there's a next page

    Loading...
    Last updated on