Organization Properties

Attach your own metadata to an organization as a JSON object, readable through the REST API.

Organization properties hold additional metadata about an organization as a free-form JSON object. The object is available through the REST API, which makes it a useful place to keep information your own applications and integrations need to read alongside the organization.

Typical uses are recording identifiers from another system, such as a customer number in your ERP, or storing configuration that an integration of yours reads at runtime.

Editing the object

Open Organization properties on the General settings page, edit the JSON in the editor, and select Save. The content must be a single valid JSON object, and an organization with nothing set shows an empty one:

{}

The editor replaces the whole object, so an application writing here through the API and a person editing in the UI can overwrite each other. Read the current value before writing a new one, and keep keys that belong to other consumers intact.

Organization properties describe the organization. For metadata on a single project or site, use workspace properties; for metadata on individual devices, use custom fields.