Data API

Read and write any entity in your workspace — dynamic and core — over a clean REST interface.

Overview

The Data API gives you full CRUD over every entity in your workspace: the modules you build in the Builder and the core ones like HR. Same URLs, same JSON, whatever your data model looks like.

Every call runs through the same engine the app uses — your record rules, field permissions and validation pipeline all apply — so the API can never bypass your business logic.

What you can do

List, filter & search

Page through records with page/limit, full-text search, sort, and equality filters on any field.

Create & update

Write records with a simple data envelope; partial updates and optimistic concurrency supported.

Schema-aware

Fetch an entity schema to discover fields and types before you read or write.

Reference

Authenticate with a Bearer key and call the clean endpoints.

# List employees (paginated, searchable, filterable)
curl "https://api.megorix.com/data/hr/employees?page=1&limit=20&search=ana&status=active" \
  -H "Authorization: Bearer $MEGORIX_API_KEY"

# Create a record
curl -X POST https://api.megorix.com/data/hr/employees \
  -H "Authorization: Bearer $MEGORIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": { "firstName": "Ana", "lastName": "Silva" } }'

# Update a record (partial)
curl -X PATCH https://api.megorix.com/data/hr/employees/<id> \
  -H "Authorization: Bearer $MEGORIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": { "lastName": "Costa" } }'

Endpoints

GET

/data/:moduleSlug/:entitySlugList records (page, limit, search, filters)

GET

/data/:moduleSlug/:entitySlug/schemaEntity schema (fields + types)

GET

/data/:moduleSlug/:entitySlug/:idGet one record

POST

/data/:moduleSlug/:entitySlugCreate a record

PATCH

/data/:moduleSlug/:entitySlug/:idUpdate a record

DELETE

/data/:moduleSlug/:entitySlug/:idDelete a record

Try it now

Open the interactive API reference and make your first call in minutes.

API reference See plans