Retrieve workspace context for initialization

GET

https://api.applivery.io/v1/organizations/{organizationId}/workspace

curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/workspace" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/workspace", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/workspace",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Organization unique identifier or URL-friendly slug used for workspace access, API routing, and resource isolation across dashboard.

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Responses

200 Response application/json

status boolean optional

data object optional

organization object optional

Complete organization entity containing workspace settings subscription details and feature configuration.

id string optional

Organization unique identifier used for database references, API responses, and internal system operations throughout platform.

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

Organization display name shown throughout dashboard interface for workspace identification and administrative purposes across all features.

≤ 128 characters

slug string optional

URL-friendly workspace identifier enabling human-readable access paths and custom branding in dashboard URLs and API endpoints.

≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$

webSiteUrl string optional

Public website URL for organization providing external reference link displayed in workspace settings and support communications.

≤ 256 characters

type string optional

Organization classification type defining workspace scope and administrative boundaries currently limited to company entity type.

personal company

subscriptions array [object] optional

Active and historical subscription records defining workspace access permissions feature entitlements and billing status.

loginProviders object optional

Authentication provider configurations defining allowed login methods for dashboard store and MDM portal access security.

limits object optional

Resource quota limits derived from active subscription defining maximum allowed applications builds downloads and devices.

allows object optional

Feature capability flags derived from subscription indicating which advanced features are enabled for workspace.

counts object optional

Current resource usage statistics showing consumed quotas for applications collaborators devices and storage.

contactInfo object optional

Organization contact information for support communications, billing notifications, and administrative correspondence throughout system.

store object optional

Application store configuration settings defining custom domain and employee access portal customization.

branding object optional

Visual identity customization settings including logo images and color schemes for white-label workspace presentation.

security object optional

Security context for authenticated user including access role and permission level within workspace.

planAssignment object optional

configuration object optional

Organization operational settings with storage provider details and complete feature configuration policies.

blocked boolean optional

Flag indicating workspace suspension status preventing access when payment issues or policy violations detected.

blockedReason string optional

Explanation for workspace suspension describing payment failure policy violation or administrative action causing block.

≤ 256 characters

trialIniDate string optional

Trial period start date in ISO format with null indicating no trial or converted paid subscription.

Format: date-time

trialEndDate string optional

Trial period expiration date when free access ends requiring subscription upgrade or workspace suspension.

Format: date-time

lastPlan string optional

Most recent subscription plan code for workspace enabling billing history tracking and renewal recommendations.

≤ 128 characters

billingReason string optional

Current billing status reason explaining subscription state such as trial active canceled or payment issues.

noBilling noSubs subscribe

lastActivityDate string optional

Format: date-time

createdBy string optional

User identifier who created organization workspace establishing initial ownership and administrative responsibility.

Match pattern: ^[a-fA-F0-9]{24}$

createdAt string optional

ISO timestamp when organization workspace was created for lifecycle tracking and audit purposes.

Format: date-time

updatedAt string optional

ISO timestamp of last organization modification for change tracking synchronization and audit trail.

Format: date-time

store object optional

Application store configuration entity containing custom domain settings and employee portal customization.

id string optional

Unique identifier for the store entity within the organization context.

Match pattern: ^[a-fA-F0-9]{24}$

organization string optional

Identifier of the organization to which the store belongs.

Match pattern: ^[a-fA-F0-9]{24}$

security string optional

Security configuration type for the store, selected from predefined options.

public logged

customDomain string optional

Custom domain name assigned to the store for external access.

branding object optional

configuration object optional

createdBy string optional

Identifier of the user who created the store.

Match pattern: ^[a-fA-F0-9]{24}$

updatedAt string optional

Timestamp when the store was last updated, in ISO-8601 format.

Format: date-time

createdAt string optional

Timestamp when the store was created, in ISO-8601 format.

Format: date-time

emmEnterprise object optional

Android Enterprise EMM configuration entity for Google Managed Play integration and device management.

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

emailText string optional

adminEmail string optional

≤ 256 characters · Format: email

config object optional

error string optional

≤ 256 characters

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

_config object optional

admEnterprise object optional

Apple Device Management enterprise configuration for iOS macOS enrollment and application deployment.

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

certificates object optional

history array [object] optional

dep object optional

configuration object optional

organizationInfo object optional

protectionRules object optional

aosEnterprise object optional

AOSP enterprise configuration for non-GMS Android management, including custom DPC settings and an optional push provider override.

id string optional

AOSP enterprise unique identifier for non-GMS Android organization tenant.

Match pattern: ^[a-fA-F0-9]{24}$

organizationId string optional

Organization identifier associated to the AOSP enterprise configuration.

Match pattern: ^[a-fA-F0-9]{24}$

configuration object optional

AOSP enterprise runtime configuration object used by the custom DPC management flow.

pushNotificationProvider string optional

Optional push notification provider override used to send policy sync, command, and challenge notifications to AOSP devices. When omitted, the global default provider is used.

Match pattern: ^[a-fA-F0-9]{24}$

updatedAt string optional

ISO timestamp of the latest AOSP enterprise configuration update.

Format: date-time

createdAt string optional

ISO timestamp when the AOSP enterprise configuration was created.

Format: date-time

winEnterprise object optional

Windows enterprise configuration for MDM enrollment and application deployment on Windows devices.

id string optional

Unique identifier for the Windows enterprise configuration entity enabling targeted operations and relationship tracking across the platform.

Match pattern: ^[a-fA-F0-9]{24}$

domain string optional

FQDN for Windows device enrollment. Must be enterpriseenrollment.your-domain (subdomain enterpriseenrollment under your DNS zone), with CNAME pointing to the platform distribution proxy as for store custom domains.

≤ 256 characters

updatedAt string optional

Timestamp of the most recent modification to the enterprise configuration tracking changes and updates for audit purposes.

Format: date-time

createdAt string optional

Timestamp when the Windows enterprise configuration was initially created establishing the baseline for all subsequent modifications and tracking.

Format: date-time

organizationInfo object optional

Organization identity and branding information inherited from the parent organization context providing consistent presentation across all device interactions.

buildPlatforms array [string] optional

List of mobile platforms enabled for build processing including iOS Android Windows macOS tvOS watchOS.

segmentTree any optional

{
    "status": true,
    "data": {
        "organization": {},
        "store": {},
        "emmEnterprise": {},
        "admEnterprise": {},
        "aosEnterprise": {
            "id": "698f42e5457fafa13d0887b2",
            "organizationId": "698f42e5457fafa13d088794",
            "configuration": {},
            "pushNotificationProvider": "698f42e5457fafa13d0887b3",
            "createdAt": "2026-02-20T09: 00:00Z",
            "updatedAt": "2026-02-20T09: 00:00Z"
        },
        "winEnterprise": {},
        "buildPlatforms": [
            "ios",
            "android",
            "windows"
        ],
        "segmentTree": "string"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5010

message string optional

Billing platform error

{
    "status": false,
    "error": {
        "code": 5010,
        "message": "Billing platform error"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4001

message string optional

Unauthorized

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}

Request

Authorization

Path Params1

Responses