RidgeCRM Developer Docs

Data Model

Custom objects

Define tenant-owned entities and expose them through records, pages, and APIs.

Definition lifecycle

  • Create a custom object definition with API name, labels, and org ownership.
  • Add fields with types and constraints.
  • Deploy the object so RidgeCRM can store records.
  • Create records through the platform API or future UI surfaces.
  • Expose the object through list views, layouts, apps, and custom pages.
1

Define

Create the object name, labels, API name, and org-owned metadata.

2

Shape

Add fields, relationships, validation, layouts, and list views.

3

Deploy

Provision storage and mark the definition ready for records.

4

Use

Create records through APIs and surface them in apps or custom pages.

API shape

http

Custom object API family

GET    /api/v1/platform/custom-objects
POST   /api/v1/platform/custom-objects
GET    /api/v1/platform/custom-objects/{definitionId}
POST   /api/v1/platform/custom-objects/{definitionId}/fields
POST   /api/v1/platform/custom-objects/{definitionId}/deploy
GET    /api/v1/platform/custom-objects/{definitionId}/records