API product catalogDeveloper Platform, Sandbox & Key Management

List this partner's OnPrem installation status

Developer Platform, Sandbox & Key Management

GET

/installations

Production onlylistPartnerInstallations

Returns up to 25 licenses scoped to the authenticated organization, ordered by license ID. Requires accounts:read API scope and organization.read for member sessions. Available in production only. Cloud verification and operator acceptance are distinct, point-in-time evidence; neither proves continuous uptime. Installation credentials, private operator evidence URLs and administrator identifiers are omitted.

Parameters

afterstringquery

Opaque nextCursor from the previous response.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

nextCursorstring | nullRequired

installationsobject[]Required

installations[].idstringRequired

installations[].statusstringRequired

installations[].accessTypetemporary | permanentRequired

installations[].domainsstring[]Required

installations[].expiresAtstring | nullRequired

installations[].approvedImagestring | nullRequired

installations[].lastVerifiedAtstring | nullRequired

installations[].acceptedAtstring | nullRequired

installations[].installationStateaccess_blocked | operator_verified | license_verified | awaiting_installationRequired

Response codes

200Organization-owned installation status; no-store response.

400Invalid cursor.

401Valid partner authentication required.

403Missing scope or member permission.

503Installation service unavailable.

Request reference

Production only

after Optional · query

Use the API Reference for this production-only or streaming operation.

https://mystocks.africa/api/v1/partner/installations

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "installations",
    "nextCursor"
  ],
  "properties": {
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "installations": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "status",
          "accessType",
          "domains",
          "expiresAt",
          "approvedImage",
          "lastVerifiedAt",
          "installationState",
          "acceptedAt"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "accessType": {
            "type": "string",
            "enum": [
              "temporary",
              "permanent"
            ]
          },
          "domains": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "expiresAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "approvedImage": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastVerifiedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "acceptedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "installationState": {
            "type": "string",
            "enum": [
              "access_blocked",
              "operator_verified",
              "license_verified",
              "awaiting_installation"
            ]
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/v1/partner/installations' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

POST /certification

GET /me