Download a sample CSV template for the given entity type. · Atomicwork | Product

Documentation Integrations Guides API Reference Guides MCP Tools API Reference

Access Management

GETList available apps GETList available entitlements POSTCreate an entitlement POSTCreate a grant for a user POSTList grants with filters PUTUpdate a grant GETGet grant history POSTRevoke a grant POSTCreate a policy

Agent Groups

GETGet workspace agent groups GETGet workspace agent group members POSTAdd workspace agent group member DELDelete workspace agent group member

Assets

POSTCreate Asset GETGet List of all Asset attributes POSTAsset List with views, and filters.GETGet Form Fields of an AssetType GETGet List of Assets for a user GETGet Asset Details PUTUpdate Asset PATCHPartially update an asset (RFC 7386 JSON Merge Patch)DELDelete Asset GETGet Asset Activities

Audit Logs

GETGet all audit logs POSTList audit logs with filters

Business Hour Config

GETRetrieve Business Hour Configurations GETRetrieve Business Hour Configurations

Change Management

GETRetrieve all the templates a logged in user can raise changes from (scoped to the workspaces the user is a member of); when for_user_id is supplied the list is curated for that profile user POSTCreate Change in workspace POSTCreate Change with File Uploads GETGet Change by display ID PATCHPatch Change by display ID GETGet Change Notes and activities GETGet notes for change by display ID POSTCreate note for change by display ID POSTGet changes by filter

Custom Objects

GETList custom objects POSTCreate a custom object instance GETGet custom object details by numeric id PUTUpdate a custom object instance PATCHPartial update a custom object instance (single-field edits)DELSoft delete a custom object instance GETGet only the relationship fields of a custom object GETGet filter fields for custom object list view GETGet CO field picker values (dropdown/multi-dropdown/relationship options)POSTList custom objects with filtering and sorting POSTExport custom objects to CSV (async, emailed)

Entities

GETGet all linked entities with relationship information POSTLink multiple entities at once

Forms

GETGet change fields applicable (visible) to current user GETGet request fields applicable (visible) to current user GETGet request fields applicable (visible) to current user GETGet list of options for the field identified by reference_key GETGet list of options for the field identified by reference_key

Import Jobs

GETList import jobs POSTCreate an import job and start validation GETList importable fields for an entity_type / entity_id, with auto-mapping metadata.GETDownload a sample CSV template for the given entity type.POSTValidate adapter_config + CSV headers without uploading the file.GETGet an import job by id POSTCancel an in-progress import job workflow POSTStart dry-run workflow GETGet presigned URL for dry-run result CSV POSTStart execution workflow GETGet import job execution status GETGet import job execution error file download URL GETGet presigned URL for execution result CSV GETGet presigned URL for the originally-uploaded source CSV.GETGet import job validation status GETGet import job validation error file download URL

Problems

POSTCreate problem request GETRetrieve Problem Request Assessment Form POSTUpdate Problem Request Assessment Form GETRetrieve Problem Request Tasks POSTCreate task for problem request GETRetrieve Problem Request Task PUTUpdate Problem Request Task

Requests

POSTCreate request POSTBulk action on requests POSTCreate service request for item POSTLoad a request Kanban board (1D or 2D), single call POSTGet requests by filter POSTCreate major incident request GETGet Request PATCHPatch request GETGet Request PATCHPatch request GETGet Request Notes and activities PATCHAdd Followers to a Request GETGet Followers of a Request PUTAdd or Remove Followers POSTMove Request GETGet Request Notes POSTCreate request notes PUTTrash Request GETRetrieve Service Request Items POSTAdd service item instance to service request GETRetrieve Service Request PATCHPatch Service Request GETList Impact Options POSTGet requests by filter

Service Catalog

GETGet catalogue item fields POSTBulk create catalogue item fields GETGet category POSTCreate category PATCHPatch Category GETGet catalogue item POSTCreate catalogue item GETRetrieve catalogue Item PATCHPatch catalogue item GETGet Service Items List GETRetrieve Service Item

Tags

GETGet tags POSTCreate Tag Option GETGet tag PUTUpdate Tag Option DELDelete Tag Option

Users

GETGet users POSTCreate user POSTInvite Users GETGet paginated users list POSTUser workspace invite GETGet a user by email PATCHRestore user in organization GETGet paginated users list in a segment GETRetrieve User PUTUpdate User PATCHPatch a user DELDelete user from organization POSTPatch a user PATCHRestore a user

Workflows

POSTClone a Request automations of a Workspace GETGet request automation definitions GETGet actions for request automations GETGet placeholders, adhoc query conditions for request automation GETGet Request automation Definition of a Workspace GETGet output fields for action GETGet output fields for action GETGet placeholder fields GETGet previous actions with output fields GETGet details of a request field GETList request automations with pagination GETList versions of a request automation GETGenerate description for the difference in workflows of the versions GETGet specific version of a request automation

Workspaces

GETGet list of workspaces GETGet workspace details GETGet workspace members

⌘K

Import Jobs

Download a sample CSV template for the given entity type.

GET https://{tenant}.atomicwork.com/api/v1/import-jobs/sample-template

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

entity_typequeryenum (string)required

Allowed valuesCUSTOM_OBJECT

entity_idqueryinteger

required

Response

200

Successful response

cURL

cURL

curl -X GET 'https://{tenant}.atomicwork.com/api/v1/import-jobs/sample-template' \
  -H 'X-Api-Key: <api-key>'