REGION: Region
The REGION entity represents a geographic or operational region for grouping and classification of entities across the platform.
REGION definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches REGION.Entity properties
| Property | Value |
|---|---|
| Entity code | REGION |
| Display name | Region |
| Plural | Regions |
| Level | 40000 |
Use cases
REGION is a simple reference entity providing configurable regional groupings. Unlike COUNTRY (which stores standardised ISO data), REGION is freeform - organisations define their own regional boundaries (e.g., 'EMEA', 'Asia Pacific', 'North America') to suit their operational structure. The entity has just name and description fields, keeping it deliberately minimal as a classification lookup. At level 40000, it sits higher in the navigation hierarchy than other reference entities (which are typically at 250), suggesting it may be used in more prominent administrative contexts. Regions can be referenced by other entities for geographic filtering and reporting segmentation. The entity is distinct from REPREGION (reporting regions), which serves a more specific financial reporting purpose and includes a code field.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. |
Relationships
- No declared relationships in the default definition.
Creating a Region via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "REGION",
"level": 40000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"description": "Long description text."
}Listing REGION records
# All regions in your tenant
GET /v1/entities/REGION/SUB