Organization

Última atualização: 22 de junho de 2026

A Organization é o contêiner de nível mais alto que abriga as Spaces. Uma empresa ou equipe corresponde a uma Organization, e sob ela ficam várias Spaces. Como o plano de assinatura (plan) e os membros são gerenciados no nível da Organization, a cobrança e as permissões dos integrantes são aplicadas com base nesta Organization, e não na Space.

A lista de Organizations a que você pertence é consultada por GET /me/organization-memberships. Este recurso não possui um endpoint que retorne a lista completa.

Estrutura do recurso

A seguir está a resposta da consulta individual da Organization "DailyWear Companhia". Ela possui sys (propriedades de sistema) e as propriedades de corpo name e description.

{
  "sys": {
    "id": "ilLRJxDp",
    "type": "Organization",
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-05-11T10:51:16.832Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "updatedAt": "2026-05-11T10:51:16.832Z",
    "version": 1,
    "isOfficial": false,
    "plan": { "sys": { "id": "free", "type": "Refer", "targetType": "Plan" } }
  },
  "name": "DailyWear Companhia",
  "description": "Empresa que administra uma loja on-line de roupas e acessórios"
}

Chaves principais:

  • name: o nome da Organization (1 a 64 caracteres). É o nome de exibição da empresa ou equipe.
  • description: uma descrição da Organization (1 a 128 caracteres, opcional).
  • plan: um Refer<Plan> que aponta para o plano de assinatura desta Organization (por exemplo, free). O plano de cobrança está vinculado aqui.
  • isOfficial: indica se a Organization é oficial (boolean).

Propriedades de sistema (sys) e corpo

Toda Organization mantém as propriedades de sistema comuns no objeto sys. createdBy e updatedBy entram no formato Refer ({ "sys": { "id", "type": "Refer", "targetType" } }), e plan é um Refer<Plan>.

PropriedadeTipoDescrição
idstringIdentificador único do recurso.
typestringTipo do recurso. Para Organization é sempre "Organization".
createdByRefer<User>Usuário que criou.
createdAtstring (date-time)Momento da criação.
updatedByRefer<User>Último usuário que modificou.
updatedAtstring (date-time)Momento da última modificação.
versioninteger (≥1)Versão do recurso. Aumenta em 1 a cada modificação.
isOfficialbooleanIndica se a Organization é oficial.
planRefer<Plan>Plano de assinatura. Por exemplo: free.

Propriedades de corpo:

PropriedadeTipoDescrição
namestring (1 a 64)Nome da Organization. Definido na criação e na modificação.
descriptionstring (1 a 128)Descrição da Organization. Item opcional.
iconstring (leitura) / object (escrita)Ícone da Organization. Na resposta é uma string com a URL da imagem. Na requisição de modificação, é enviado como um objeto que aponta para o arquivo carregado: { "upload": { "sys": { ..., "targetType": "Upload" } } } (referência ao Upload recebido pela Upload API).

A Organization é um recurso de configuração que não possui o conceito de publicação. Por isso, ao contrário de Content e Media, o sys não tem publish, archive nem status, apenas version. O version aumenta a cada modificação da Organization.

API

A URL base de todos os endpoints abaixo é https://cma.weegloo.com/v1, e o cabeçalho Authorization exige um token Bearer que autentique no CMA. Para modificação total ou parcial, é necessário enviar também o cabeçalho X-Weegloo-Version (o sys.version atual do recurso) para o controle de concorrência otimista. A criação e a exclusão não usam esse cabeçalho.