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 users API

The users API from Atomicwork — 10 operation(s) for users.

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

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

This API exposes 14 operations across 10 paths, and defines 32 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.

14 operations 10 paths 32 schemas 1 DELETE5 GET3 PATCH4 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 users API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth).

Paths & Operations 14

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

users 14
POST
/api/v1/users/invite
Invite Users
postapi-v-1-users-invite 2 params body → 200
POST
/api/v1/users/workspaces/invite
User workspace invite
postapi-v-1-users-workspaces-invite 2 params body → 200
GET
/api/v1/users
Get users
getapi-v-1-users 7 params → 200
POST
/api/v1/users
Create user
postapi-v-1-users 3 params body → 200
GET
/api/v1/users/list
Get paginated users list
getapi-v-1-users-list 17 params → 200
GET
/api/v1/users/{segment_id}/list
Get paginated users list in a segment
getapi-v-1-users-segment-id-list 11 params → 200
GET
/api/v1/users/{user_id}
Retrieve User
getapi-v-1-users-user-id 3 params → 200
PUT
/api/v1/users/{user_id}
Update User
putapi-v-1-users-user-id 3 params body → 200
DELETE
/api/v1/users/{user_id}
Delete user from organization
deleteapi-v-1-users-user-id 3 params → 200
PATCH
/api/v1/users/{user_id}
Patch a user
patchapi-v-1-users-user-id 3 params body → 200
POST
/api/v1/users/{user_id}/properties
Patch a user
postapi-v-1-users-user-id-properties 3 params body → 200
PATCH
/api/v1/users/{user_id}/restore
Restore a user
patchapi-v-1-users-user-id-restore 3 params body → 200
PATCH
/api/v1/users/{email}/restore-by-email
Restore user in organization
patchapi-v-1-users-email-restore-by-email 3 params body → 200
GET
/api/v1/users/{email}/email-lookup
Get a user by email
getapi-v-1-users-email-email-lookup 3 params → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ApiV1UsersPostRequestBodyContentApplicationJsonSchemaWorkspacesItems (2 properties), ApiV1UsersInvitePostRequestBodyContentApplicationJsonSchemaWorkspacesItems (2 properties), ApiV1UsersWorkspacesInvitePostRequestBodyContentApplicationJsonSchemaWorkspacesItems (2 properties). Each schema is shown below with its type and property counts.

Users_postapi_v1_users__user_id__properties_Response_200
object
Empty response body
Users_postapi_v1_users_Response_200
object
Empty response body
Users_putapi_v1_users__user_id_Response_200
object
Empty response body
ApiV1UsersListGetParametersUserStatus
string
Users_patchapi_v1_users__user_id_Response_200
object
Empty response body
ApiV1UsersUserIdPutRequestBodyContentApplicationJsonSchemaCustomFields
object
ApiV1UsersPostRequestBodyContentApplicationJsonSchemaType
string
Users_getapi_v1_users_Response_200
object
Empty response body
ApiV1UsersPostRequestBodyContentApplicationJsonSchemaExternalAppType
string
ApiV1UsersWorkspacesInvitePostRequestBodyContentApplicationJsonSchemaWorkspacesItems
object
2 properties
ApiV1UsersInvitePostRequestBodyContentApplicationJsonSchemaWorkspacesItems
object
2 properties
Users_postapi_v1_users_invite_Response_200
object
Empty response body
ApiV1UsersSegmentIdListGetParametersType
string
Users_deleteapi_v1_users__user_id_Response_200
object
Empty response body
Users_patchapi_v1_users__email__restore_by_email_Response_200
object
Empty response body
Users_getapi_v1_users__user_id_Response_200
object
Empty response body
ApiV1UsersUserIdPutRequestBodyContentApplicationJsonSchemaExternalAppType
string
ApiV1UsersListGetParametersTypesSchemaItems
string
Users_patchapi_v1_users__user_id__restore_Response_200
object
Empty response body
ApiV1UsersListGetParametersExpandSchemaItems
string
ApiV1UsersGetParametersTypesSchemaItems
string
Users_getapi_v1_users_list_Response_200
object
Empty response body
ApiV1UsersListGetParametersInvitationStatus
string
Users_postapi_v1_users_workspaces_invite_Response_200
object
Empty response body
ApiV1UsersPostRequestBodyContentApplicationJsonSchemaWorkspacesItems
object
2 properties
Users_getapi_v1_users__segment_id__list_Response_200
object
Empty response body
ApiV1UsersWorkspacesInvitePostRequestBodyContentApplicationJsonSchemaType
string
Users_getapi_v1_users__email__email_lookup_Response_200
object
Empty response body
ApiV1UsersPostRequestBodyContentApplicationJsonSchemaCustomFields
object
ApiV1UsersSegmentIdListGetParametersSortOrder
string
ApiV1UsersListGetParametersSortOrder
string
ApiV1UsersInvitePostRequestBodyContentApplicationJsonSchemaType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atomicwork-users-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 customObjects API
Atomicwork entities API
Atomicwork forms API
Atomicwork problems API
Atomicwork requests API
Atomicwork serviceCatalog API
Where this information came from

This is an independent, third-party profile of Atomicwork users 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.