How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atomicwork customObjects API

The customObjects API from Atomicwork — 7 operation(s) for customobjects.

Atomicwork customObjects API is one of 16 APIs that Atomicwork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 7 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant}.atomicwork.com.

11 operations 7 paths 20 schemas 1 DELETE5 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{tenant}.atomicwork.com/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Atomicwork customObjects API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth).

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

customObjects 11
GET
/api/v1/custom-objects/view-fields
Get filter fields for custom object list view
getapi-v-1-custom-objects-view-fields 3 params → 200
GET
/api/v1/custom-objects
List custom objects
getapi-v-1-custom-objects 6 params → 200
POST
/api/v1/custom-objects
Create a custom object instance
postapi-v-1-custom-objects 2 params body → 200
POST
/api/v1/custom-objects/{objectTypeId}/list
List custom objects with filtering and sorting
postapi-v-1-custom-objects-object-type-id-list 3 params body → 200
GET
/api/v1/custom-objects/{objectTypeId}/fields
Get CO field picker values (dropdown/multi-dropdown/relationship options)
getapi-v-1-custom-objects-object-type-id-fields 10 params → 200
GET
/api/v1/custom-objects/by-id/{id}
Get custom object details by numeric id
getapi-v-1-custom-objects-by-id-id 3 params → 200
PUT
/api/v1/custom-objects/by-id/{id}
Update a custom object instance
putapi-v-1-custom-objects-by-id-id 3 params body → 200
DELETE
/api/v1/custom-objects/by-id/{id}
Soft delete a custom object instance
deleteapi-v-1-custom-objects-by-id-id 3 params → 200
PATCH
/api/v1/custom-objects/by-id/{id}
Partial update a custom object instance (single-field edits)
patchapi-v-1-custom-objects-by-id-id 3 params body → 200
GET
/api/v1/custom-objects/by-id/{id}/relationships
Get only the relationship fields of a custom object
getapi-v-1-custom-objects-by-id-id-relationships 3 params → 200
POST
/api/v1/custom-objects/{objectTypeId}/list/download
Export custom objects to CSV (async, emailed)
postapi-v-1-custom-objects-object-type-id-list-download 3 params body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItems (3 properties), ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems (2 properties). Each schema is shown below with its type and property counts.

ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItemsValue
object
Custom_Objects_putapi_v1_custom_objects_by_id__id_Response_200
object
Empty response body
Custom_Objects_getapi_v1_custom_objects_by_id__id__relationships_Response_200
object
Empty response body
ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsOperator
string
Custom_Objects_patchapi_v1_custom_objects_by_id__id_Response_200
object
Empty response body
ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaScope
string
Scope of the object type (GLOBAL or WORKSPACE)
Custom_Objects_postapi_v1_custom_objects__objectTypeId__list_Response_200
object
Empty response body
ApiV1CustomObjectsPostRequestBodyContentApplicationJsonSchemaFormFields
object
Custom field values keyed by field referencekey. Must include displayname, the reserved system field for every custom object type. formfields.displayname is tr…
Custom_Objects_postapi_v1_custom_objects_Response_200
object
Empty response body
ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems
object
2 properties
Custom_Objects_getapi_v1_custom_objects_by_id__id_Response_200
object
Empty response body
Custom_Objects_postapi_v1_custom_objects__objectTypeId__list_download_Response_200
object
Empty response body
ApiV1CustomObjectsByIdIdPatchRequestBodyContentApplicationJsonSchemaFormFields
object
Partial custom field values keyed by field referencekey. formfields.displayname may be sent alone for inline name edits.
ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaSort
string
Sort order for custom object list view results
Custom_Objects_getapi_v1_custom_objects__objectTypeId__fields_Response_200
object
Empty response body
Custom_Objects_deleteapi_v1_custom_objects_by_id__id_Response_200
object
Empty response body
Custom_Objects_getapi_v1_custom_objects_view_fields_Response_200
object
Empty response body
ApiV1CustomObjectsByIdIdPutRequestBodyContentApplicationJsonSchemaFormFields
object
Partial custom field values keyed by field referencekey. To rename the object, send formfields.displayname. If absent, the existing display name is preserved.…
Custom_Objects_getapi_v1_custom_objects_Response_200
object
Empty response body
ApiV1CustomObjectsObjectTypeIdListPostRequestBodyContentApplicationJsonSchemaFiltersItems
object
Filter condition for the custom object list view. Extends BaseListFilterDTO using the standard attribute/operator/values pattern. The attribute field holds eit…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atomicwork-customobjects-api-openapi.yml Raw ↑

Other APIs Atomicwork publishes across the network.

Atomicwork accessManagement API
Atomicwork agentGroups API
Atomicwork assets API
Atomicwork auditLogs API
Atomicwork businessHourConfig API
Atomicwork changeManagement API
Atomicwork entities API
Atomicwork forms API
Atomicwork problems API
Atomicwork requests API
Atomicwork serviceCatalog API
Atomicwork tags API
Where this information came from

This is an independent, third-party profile of Atomicwork customObjects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.