Retrieve workspace context for initialization

GET

/v1/organizations/:organizationId/workspace

Retrieve workspace context for initialization

Required Permission: base.organization.management.get

Retrieves complete workspace context including organization details, application store configuration, enterprise mobility management settings, and device enrollment for dashboard initialization.

Request

Add parameter in 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-zA-Z0-9][a-zA-Z0-9-]+[a-zA-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.

plan string optional

Subscription plan identifier referencing pricing tier feature set and resource limits for workspace.

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

planCode string optional

Human-readable plan code identifying subscription tier for billing and support reference purposes.

≤ 256 characters

iniDate string optional

Subscription start date in ISO format marking beginning of billing cycle and feature access.

Format: date-time

endDate string optional

Subscription end date in ISO format indicating renewal deadline or cancellation effective date.

Format: date-time

endedAt string optional

Actual subscription termination timestamp when canceled or expired with null indicating active status.

Format: date-time

status string optional

Current subscription state indicating payment health and access validity including active canceled past_due expired.

active canceled past_due expired

metadata object optional

Subscription plan metadata containing feature limits allowed capabilities pricing details and target configuration.

limits object optional

Resource quota limits defining maximum allowed applications builds downloads collaborators and managed devices.

allows object optional

Feature capability flags indicating which advanced features are enabled for subscription tier.

target string optional

Subscription plan target indicating resource type being metered such as devices users or builds.

company personal unknown

type string optional

Subscription business model type indicating SaaS perpetual or trial licensing arrangement.

standard default unknown mdm custom enterprise

periodicity string optional

Billing cycle frequency defining monthly annual or custom payment intervals with null for one-time.

m y d -

price integer optional

Base subscription price per billing period in smallest currency unit for chosen plan tier.

≥ 0

packagePrice integer optional

Additional unit price for exceeding included package limits enabling consumption-based billing.

≥ 0

packageLength integer optional

Number of units included in base subscription package before additional charges apply.

≥ 0

packageTarget string optional

Resource type for package-based pricing defining what units are counted for overage charges.

≤ 128 characters

chargeType string optional

Billing charge calculation method defining how subscription costs are computed and invoiced.

≤ 128 characters

customer string optional

Billing customer identifier linking subscription to payment method and invoice records in billing platform.

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

id string optional

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

planDescription string optional

Human-readable subscription plan description displayed in dashboard and billing communications.

≤ 128 characters

type string optional

standard default unknown mdm custom enterprise

description string optional

Detailed subscription description explaining included features limits and special terms for workspace access.

≤ 256 characters

paymentIntent object optional

Payment processing information including transaction status errors and authentication requirements for subscription.

id string optional

≤ 128 characters

secret string optional

≤ 500 characters

status string optional

≤ 500 characters

error object optional

loginProviders object optional

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

dashboard array [string] optional

Allowed authentication methods for dashboard access including password Google SSO enabling administrative login security configuration.

store array [string] optional

Allowed authentication methods for application store access controlling employee login mechanisms and security policies.

mdm array [string] optional

Allowed authentication methods for MDM portal access defining device administrator login options and security requirements.

limits object optional

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

apps integer optional

≥ 0

builds integer optional

≥ 0

downloads integer optional

≥ 0

collaborators integer optional

≥ 0

employees integer optional

≥ 0

mdmDevices integer optional

≥ 0

locationTrackingTime integer optional

≥ 0

mdmAssetsStorageSize integer optional

≥ 0

maxBuildRetentionDays integer optional

≥ 0

maxBuildsRetainedPerPublication integer optional

≥ 0

maxPublicationsPerApp integer optional

≥ 0

mdmAutomationRules integer optional

≥ 0

deviceAudiences integer optional

≥ 0

userAudiences integer optional

≥ 0

maxDepthSegments integer optional

≥ 0

maxNumSegments integer optional

≥ 0

allows object optional

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

passwordApps boolean optional

loggedApps boolean optional

unlistedApps boolean optional

loggedStores boolean optional

nativeSDK boolean optional

customBranding boolean optional

customDomain boolean optional

ssoLogin boolean optional

changeS3Bucket boolean optional

customS3Bucket boolean optional

appleIpad boolean optional

appleMac boolean optional

appleWatch boolean optional

appleTv boolean optional

androidZeroTouch boolean optional

appleDEP boolean optional

appleVPP boolean optional

serviceAccounts boolean optional

duplicatePolicy boolean optional

mdmAssets boolean optional

advancedLauncher boolean optional

androidAgent boolean optional

iosAgent boolean optional

macosAgent boolean optional

macosScripts boolean optional

androidManagedConfigurations boolean optional

appleManagedConfigurations boolean optional

androidRemoteSupport boolean optional

appleRemoteSupport boolean optional

inventory boolean optional

windowsMdm boolean optional

windowsAgent boolean optional

windowsScripts boolean optional

countryAccessControl boolean optional

assistant boolean optional

userAudiences boolean optional

unlimitedBuildRetention boolean optional

policyComposition boolean optional

deviceAudiences boolean optional

certificateProviders boolean optional

segments boolean optional

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.

email string optional

Primary contact email address for organization receiving system notifications, support responses, and billing communications.

≤ 256 characters · Format: email

phoneNumber string optional

Organization contact phone number for support escalations and administrative communications when required.

≤ 128 characters

store object optional

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

customDomain string optional

Custom domain name for branded application store replacing default Applivery URLs with organization domain.

≤ 256 characters

branding object optional

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

logo string optional

Organization logo image URL displayed in dashboard header, emails, and application stores for brand recognition.

≤ 256 characters

picture string optional

Organization banner picture URL used for workspace customization and visual identity in user-facing interfaces.

primaryColor string optional

Primary brand color in hexadecimal format applied throughout dashboard interface for consistent visual identity.

Match pattern: ^#[a-zA-Z0-9]{6}$

security object optional

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

role string optional

Access permission level granted to currently authenticated user within organization context determining authorized administrative actions.

org.owner org.admin org.editor org.viewer app.owner app.admin app.editor app.viewer unknown

configuration object optional

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

storageProvider object optional

Cloud storage provider details including identifier name region and configuration for application binary hosting.

id string optional

Storage provider unique identifier used for database references and API operations.

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

name string optional

Storage provider display name identifying cloud service and region for administrative reference.

≤ 128 characters

region string optional

Cloud provider geographic region code where application binaries and assets are stored.

≤ 128 characters

config string optional

Storage configuration type defining bucket settings access policies and performance characteristics.

≤ 128 characters

provider string optional

Cloud provider identifier indicating storage backend such as AWS Azure or Google Cloud Platform.

≤ 128 characters

notificationLanguage string optional

Default language code for system notifications and automated emails sent to organization members.

es en fr de it zh pt ru

required2FADashboard boolean optional

Flag enforcing two-factor authentication requirement for all dashboard access enhancing workspace security.

required2FAStore boolean optional

Flag enforcing two-factor authentication requirement for application store access protecting employee app distribution.

noReplyAlias string optional

Custom no-reply email address displayed as sender in automated notifications for organization branding.

≤ 256 characters · Format: email

buildPlatforms array [string] optional

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

sdkExtraBuildPlatforms array [string] optional

Additional platform build capabilities available through SDK integration beyond standard build processing.

denyTraditionalAccess boolean optional

Flag restricting traditional password authentication requiring SSO or alternative login methods for enhanced security.

buildRetentionDays number optional

Number of days to retain application builds before automatic deletion with negative one indicating unlimited retention.

Format: float · ≥ -1

buildsRetainedPerPublication number optional

Maximum number of builds preserved per publication release protecting storage while maintaining version history.

Format: float · ≥ 0

showDeviceNetworkLocation boolean optional

Flag enabling network location information display in device details for connectivity diagnostics.

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

buttonColor string optional

Hexadecimal color code used for branding the store’s main button.

Match pattern: ^#[a-zA-Z0-9]{6}$

configuration object optional

allowPublicPubApps boolean optional

Indicates whether public publisher applications are allowed in the store.

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

name string optional

≤ 128 characters

primaryColor integer optional

≥ 0

logo object optional

url string optional

≤ 256 characters

sha256Hash string optional

≤ 256 characters

enterpriseDisplayName string optional

≤ 256 characters

termsAndConditions array [object] optional

header object optional

content object optional

enterpriseType string optional

≤ 128 characters

managedGooglePlayAccountsEnterpriseType string optional

≤ 128 characters

managedGoogleDomainType string optional

≤ 128 characters

googleAuthenticationSettings object optional

googleAuthenticationRequired string optional

≤ 256 characters

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

appleId string optional

≤ 256 characters

commonName string optional

≤ 256 characters

issuedAt string optional

Format: date-time

expiredAt string optional

Format: date-time

history array [object] optional

appleId string optional

≤ 256 characters

commonName string optional

≤ 256 characters

issuedAt string optional

Format: date-time

expiredAt string optional

Format: date-time

dep object optional

config object optional

consumerKey string optional

≤ 256 characters

consumerSecret string optional

≤ 256 characters

accessToken string optional

≤ 256 characters

accessSecret string optional

≤ 256 characters

accessTokenExpiry string optional

Format: date-time

lastDeviceCursor string optional

≤ 256 characters

depEnrollUrl string optional

≤ 256 characters

configuration object optional

primaryColor string optional

≤ 256 characters

logo string optional

≤ 256 characters

contactEmail string optional

≤ 256 characters · Format: email

contactPhone string optional

≤ 256 characters

organizationInfo object optional

id string optional

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

name string optional

≤ 128 characters

slug string optional

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

store object optional

customDomain string optional

≤ 256 characters

branding object optional

logo string optional

≤ 256 characters

picture string optional

primaryColor string optional

Match pattern: ^#[a-zA-Z0-9]{6}$

configuration object optional

storageProvider string optional

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

createdBy string optional

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

protectionRules object optional

scheduleEnabled boolean optional

scheduleTimeZone string optional

Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/La_Rioja America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Ciudad_Juarez America/Coral_Harbour America/Cordoba America/Costa_Rica America/Coyhaique America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Fort_Nelson America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Monticello America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montserrat America/Nassau America/New_York America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Tijuana America/Toronto America/Tortola America/Vancouver America/Whitehorse America/Winnipeg America/Yakutat Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Colombo Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Hebron Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Katmandu Asia/Khandyga Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ulaanbaatar Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Darwin Australia/Eucla Australia/Hobart Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/Perth Australia/Sydney Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Ulyanovsk Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zurich Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis

schedule object optional

mon array [integer] optional

tue array [integer] optional

wed array [integer] optional

thu array [integer] optional

fri array [integer] optional

sat array [integer] optional

sun array [integer] optional

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

Domain identifier used for Windows device enrollment portal branding and management interface customization throughout the organization.

≤ 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.

id string optional

Unique identifier of the parent organization owning this enterprise configuration ensuring proper access control and data isolation.

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

name string optional

Organization name displayed in administrative interfaces and reporting dashboards providing clear identification throughout the management platform.

≤ 128 characters

slug string optional

URL-friendly organization identifier used in public enrollment portals and store URLs enabling branded and accessible web addresses.

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

store object optional

Organization application store configuration for device app distribution and discovery enabling managed software deployment to enrolled devices.

customDomain string optional

Custom domain configured for the organization app store and enrollment portal providing branded access points for device users.

≤ 256 characters

branding object optional

Visual branding assets applied across organization enrollment portals and dashboards ensuring consistent brand experience for all user interactions.

logo string optional

Organization logo URL used in administrative dashboards and management interfaces providing visual brand recognition for organizational administrators.

≤ 256 characters

picture string optional

Organization header image displayed in enrollment portals and public-facing interfaces creating visual impact and brand recognition for users.

primaryColor string optional

Primary brand color applied to organization portals and enrollment interfaces maintaining visual consistency with corporate identity standards.

Match pattern: ^#[a-zA-Z0-9]{6}$

configuration object optional

Organization-level infrastructure configuration inherited by enterprise settings defining storage providers and fundamental operational parameters for the organization.

storageProvider string optional

Storage provider identifier for application binaries and configuration file storage defining where device resources are stored and managed.

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

createdBy string optional

Identifier of the user who created the parent organization entity tracking administrative accountability and operational audit requirements.

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

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": {},
        "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"
    }
}