/api/v1/objectCreate an object.
Create an object.
Creates the object with a generated 12-digit slug and its default
fields: a name, a status and a description field, plus the workspace tag
field. Default field labels use the language in the X-App-Locale
header, else Accept-Language (en, ar or tr; default en). The
credential's owner gets full access to the new object's records; other
roles get access to their own records only. A slug in the body is
ignored.
Scope: object.create.
Errors:
400— the name is empty after trimming.409— an active object already has this name, ignoring letter case.422— the body is invalid, for example anameover 100 characters.
Request:
{
"name": "Partners",
"description": "Resellers and referral partners",
"icon": "tabler-building-store"
}
Response 201:
{
"status": 201,
"message": "Object created successfully",
"data": {
"id": 52,
"name": "Partners",
"slug": "482913570264",
"icon": "tabler-building-store",
"description": "Resellers and referral partners",
"permission_name": "482913570264",
"is_active": true,
"sort_order": 0,
"is_system": false,
"is_public": false,
"options": null,
"created_at": "2026-09-14T10:00:00.000Z",
"updated_at": "2026-09-14T10:00:00.000Z",
"folder_slug": null,
"default_view_slug": null,
"default_view_type": null
}
}
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredResponses
Successful response
{
"id": 1.5,
"name": "string",
"slug": "string",
"icon": "string",
"description": "string",
"permission_name": "string",
"is_active": true,
"sort_order": 1.5,
"is_system": true,
"is_public": true,
"options": "string",
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z",
"folder_slug": "string",
"default_view_slug": "string",
"default_view_type": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs