Added
{ New } - Company Management
about 1 hour ago by Dan Benshitrit
Company Management API
New endpoints
You can now manage your companies (and their domains, APKs, and external domains) directly through the API in addition to the UI.
POST /json/v3/companies— add a new company. Body:{ name, domains?, apks?, external_domains? }.namemust be alphanumeric only (no spaces or special characters), 1-100 characters. At least one ofdomains,apks, orexternal_domainsmust contain at least one value.DELETE /json/v3/companies/{companyId}— remove a company by id.POST /json/v3/companies/{companyId}/assets— adddomains,apks, and/orexternal_domainsto a company (deduplicated via$addToSet).DELETE /json/v3/companies/{companyId}/assets— removedomains,apks, and/orexternal_domainsfrom a company.
All endpoints require theapi-keyheader and the existingsearch-by-companypermission, and return the updatedcompaniesarray.
Authorization
- A user can only modify companies that belong to their own account.
- For organizations with synced data (
organization.synced_data: true), only the organization owner can add, remove, or modify companies. Non-owner members receive403 Forbiddenwith a message explaining that only the owner may perform these actions. Changes made by the owner are visible to all members through the existing organization sync. - The
GET /json/v3/my-accountresponse now includes anorganizationobject (name,role,synced_data,synced_archive,date) when the user is part of an organization. Use it to determine in advance whether the new company management endpoints will be allowed for the calling user: iforganization.synced_dataistrueandorganization.roleis not"owner", mutation calls will be rejected with403 Forbidden.
Other changes
- CORS now accepts
DELETEin addition toGET/POSTto support the new endpoints from browser clients. - OpenAPI spec updated with a new
Company Managementtag, a reusableCompanyschema, and the four new operations.
