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

List Enums IDs

get

This operation lists the Enums IDs (names)

Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully listed the service accounts
application/json
Responsestring[]
get
GET /enums HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  "text"
]

Create an Enum

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body
one ofOptional
or
or
or
or
or
Responses
201
Successfully created the service account
application/json
Responseone of
or
or
or
or
or
post
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-01T19:33:39.761Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-01T19:33:39.761Z",
    "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-01T19:33:39.761Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-01T19:33:39.761Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Retrieve an Enum

get
Authorizations
Path parameters
idstringRequired

ID of the Enum to retrieve

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully retrieved the service account
application/json
Responseone of
or
or
or
or
or
get
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-01T19:33:39.761Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-01T19:33:39.761Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update an Enum

put
Authorizations
Path parameters
idstringRequired

ID of the Enum to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body
one ofOptional
or
or
or
or
or
Responses
200
Successfully updated object
application/json
Responseone of
or
or
or
or
or
put
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-01T19:33:39.761Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-01T19:33:39.761Z",
    "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-01T19:33:39.761Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-01T19:33:39.761Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete an Enum

delete

Deletes an Enum

Authorizations
Path parameters
idstringRequired

ID of the Enum to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully deleted the object
delete
DELETE /enums/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content
PreviousEnum ObjectNextProductCatalog Object

Last updated

Was this helpful?