Enum Object REST API
Enum Objects REST API documentation and interactive testing.
For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/enums/contract
This operation lists the Enums IDs (names)
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
GET /enums HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
[
"text"
]
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
POST /enums HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"id": "text",
"description": "text",
"values": [
{
"key": "text",
"val": true,
"order": 1
}
],
"disabled": true,
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-07-05T17:05:15.509Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-05T17:05:15.509Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
{
"id": "text",
"description": "text",
"values": [
{
"key": "text",
"val": true,
"order": 1
}
],
"disabled": true,
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-07-05T17:05:15.509Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-05T17:05:15.509Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the Enum to retrieve
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
GET /enums/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
{
"id": "text",
"description": "text",
"values": [
{
"key": "text",
"val": true,
"order": 1
}
],
"disabled": true,
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-07-05T17:05:15.509Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-05T17:05:15.509Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the Enum to update
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
PUT /enums/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"id": "text",
"description": "text",
"values": [
{
"key": "text",
"val": true,
"order": 1
}
],
"disabled": true,
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-07-05T17:05:15.509Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-05T17:05:15.509Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
{
"id": "text",
"description": "text",
"values": [
{
"key": "text",
"val": true,
"order": 1
}
],
"disabled": true,
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-07-05T17:05:15.509Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-05T17:05:15.509Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
Deletes an Enum
ID of the Enum to delete
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
DELETE /enums/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
No content
Last updated
Was this helpful?