Platform · Custom Objects
Object Fields
The fields of each custom object. A field has a type, optional limits, and may be required, unique, searchable or sensitive (kept out of reports, search and anything an AI assistant is shown). A field is retired by default: it disappears from the screens and its values stay; Purge drops the column and its values. A field's key and type cannot be changed.
/api/platform/custom-object-fieldsPublished as /api/v1/custom-object-fieldsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Object Fields on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ext.co_fields · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/custom-object-fieldsList object fields
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"field_key": "text",
"label": "text",
"help": "text",
"data_type": "text",
"options": {},
"ref_target": "text",
"is_required": true,
"is_unique": true,
"is_searchable": true,
"is_sensitive": true,
"min_value": "1250.00",
"max_value": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/custom-object-fields?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/custom-object-fields/{id}Read one custom object field
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"field_key": "text",
"label": "text",
"help": "text",
"data_type": "text",
"options": {},
"ref_target": "text",
"is_required": true,
"is_unique": true,
"is_searchable": true,
"is_sensitive": true,
"min_value": "1250.00",
"max_value": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/custom-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/custom-object-fieldsPost object fields
Request body
The keys this action reads (* = required; "one of" lists the only values):
objectId, object_idResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-object-fields" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"objectId":"value","object_id":"value"}'PUT/api/platform/custom-object-fields/{id}Put object fields
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/custom-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/custom-object-fields/{id}Delete object fields
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/custom-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/custom-object-fields/choices/{kind}Choices
Path parameters
| Name | Type | Description |
|---|---|---|
kind | string (uuid) | The record's kind, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/custom-object-fields/choices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/custom-object-fields/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a custom object field, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
object_id | uuid | read only | Object — The object this field belongs to. |
field_key | text | read only | Key — Lower case letters, digits and underscores, up to 40. It becomes the column name and cannot be changed. |
label | text | read only | Label — What people see on the form and list. |
help | text | read only | Help text — Shown beside the field on the form. |
data_type | text | read only | Type — Fixed once the field exists. Allowed: text textarea number integer money percent date datetime boolean select multiselect reference |
options | jsonb | read only | Choices — Comma-separated values people may pick. |
ref_target | text | read only | Points at — A standard screen as module/screen, e.g. crm/accounts, or another object as co:object_key. |
is_required | boolean | read only | Required — A record cannot be saved without it. |
is_unique | boolean | read only | Unique — No two records may hold the same value (blank is allowed). |
is_searchable | boolean | read only | Searchable — The search box looks in this field. |
is_sensitive | boolean | read only | Sensitive — Kept out of reports, search and anything an AI assistant or agent is shown. |
min_value | numeric | read only | Smallest value — Numbers below it are refused. |
max_value | numeric | read only | Largest value — Numbers above it are refused. |
max_length | integer | read only | Longest text — Characters allowed; 4,000 for text and 20,000 for long text if empty. |
default_value | text | read only | Default value — Filled in on a new record when nobody typed anything. |
show_in_list | boolean | read only | Show on the list — A column of the list by default. |
sort_order | integer | read only | Order — Lower numbers come first on the form. |
is_active | boolean | read only | On — Off retires the field: hidden everywhere, values kept. |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_by | uuid | read only | Updated by |
updated_at | timestamp with time zone | read only | Updated at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Object Fields for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.