/api/v1/object/orderChange the display order of objects.
Change the display order of objects.
Send each object's slug with its new sort_order. Objects you leave
out keep their current value. Returns every object, active and inactive,
ordered by sort_order.
Scope: object.update.
Errors:
400— no object has one of the slugs.422— the body is invalid, for example asort_orderthat is not a number.
Request:
{
"objects": [
{ "slug": "deals", "sort_order": 1 },
{ "slug": "contacts", "sort_order": 2 }
]
}
Response 200:
{
"status": 200,
"message": "Object order updated successfully",
"data": [
{
"id": 37,
"name": "Contacts",
"slug": "contacts",
"icon": "tabler-users",
"description": "People we sell to",
"permission_name": "contacts",
"is_active": true,
"sort_order": 2,
"is_system": false,
"is_public": false,
"options": null,
"created_at": "2026-07-20T09:12:44.000Z",
"updated_at": "2026-09-01T14:03:10.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