Skip to content
/
Delete user

Zimark Integration API (v0)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server

https://docs.zimark.link/_mock/api/

https://{organizationSubdomain}.zimark-staging.link/

https://{organizationSubdomain}.zimark.link/

Zimarker

Allocate zimarker code(s) on demand for the calling organization, each with a printable, inline base64 marker image. Allocation is synchronous, atomic, and exactly-once per organization.

Render a zimarker code's marker image on demand. Public, stateless, and addressable by code at a stable URL — no authentication required.

Operations

Manifest

API endpoints for managing manifests and their associated assets/tracks.

A manifest is a container that groups assets/pallets for tracking purposes.

Operations

Shipment

API endpoints for managing shipments (multi-manifest dispatch grouping). A shipment groups one or more manifests for dispatch at a single gate; only available to organizations configured with the shipment dispatch strategy.

Operations

Track

Operations

Gate

Operations

Client

Operations

Scanner

Operations

Printing Batch

Operations

Agent

Operations

Local Manager

Operations

User

Operations

Update user

Request

Security
X-AUTH-KEY
Path
uuidstringrequired
Bodyapplication/jsonrequired
firstNamestring[ 2 .. 100 ] charactersrequired
lastNamestring[ 2 .. 100 ] charactersrequired
emailstringnon-empty^[_A-Za-z0-9-']+[#\+\.\*_A-Za-z0-9-']*@[A-Za-...required
phoneNumberstring
authorityobject(AuthorityRefDto)required
authority.​uuidstring
authority.​authorityNamestring
curl -i -X PUT \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/user/{uuid}' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "authority": {
      "uuid": "string",
      "authorityName": "string"
    }
  }'

Responses

Ok

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

firstNamestring[ 2 .. 100 ] charactersrequired

User's first name

Example: "John"
lastNamestring[ 2 .. 100 ] charactersrequired

User's last name

Example: "Doe"
emailstringnon-empty^[_A-Za-z0-9-']+[#\+\.\*_A-Za-z0-9-']*@[A-Za-...required

User's email address

Example: "john.doe@example.com"
authorityobject(AuthorityResponseV1Dto)required

User's authority with full details

authority.​createDatestring(date-time)
authority.​updateDatestring(date-time)
authority.​deepLinkstring

Deep link URL to open this entity in Ops.App.

authority.​authorityNamestring
authority.​internalboolean
authority.​permissionsArray of strings
Items Enum"BACKOFFICE_LOGIN""LOCAL_MANAGER_LOGIN""APP_LOGIN""FORKLIFT_APP_LOGIN""OPERATIONAL_APP_LOGIN""ROLE_MANAGEMENT""LOCAL_MANAGER_REMOTE_ACCESS""USER_MANAGEMENT_READ""USER_MANAGEMENT_WRITE""AGENT_MANAGEMENT_READ"
phoneNumberstring

User's phone number

Example: "+1234567890"

Delete user

Request

Security
X-AUTH-KEY
Path
uuidstringrequired
curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/user/{uuid}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Get users

Request

Security
X-AUTH-KEY
Query
rolestring

Filter users by role

pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/user?role=string&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(UserResponseV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Create user

Request

Security
X-AUTH-KEY
Bodyapplication/jsonrequired
firstNamestring[ 2 .. 100 ] charactersrequired
lastNamestring[ 2 .. 100 ] charactersrequired
emailstringnon-empty^[_A-Za-z0-9-']+[#\+\.\*_A-Za-z0-9-']*@[A-Za-...required
phoneNumberstring
authorityobject(AuthorityRefDto)required
authority.​uuidstring
authority.​authorityNamestring
passwordPolicyModestringrequired
Enum"INVITE_LINK""TEMP_PASSWORD"
passwordstring[ 6 .. 2147483647 ] characters
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/user \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "authority": {
      "uuid": "string",
      "authorityName": "string"
    },
    "passwordPolicyMode": "INVITE_LINK",
    "password": "string"
  }'

Responses

Ok

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

firstNamestring[ 2 .. 100 ] charactersrequired

User's first name

Example: "John"
lastNamestring[ 2 .. 100 ] charactersrequired

User's last name

Example: "Doe"
emailstringnon-empty^[_A-Za-z0-9-']+[#\+\.\*_A-Za-z0-9-']*@[A-Za-...required

User's email address

Example: "john.doe@example.com"
authorityobject(AuthorityResponseV1Dto)required

User's authority with full details

authority.​createDatestring(date-time)
authority.​updateDatestring(date-time)
authority.​deepLinkstring

Deep link URL to open this entity in Ops.App.

authority.​authorityNamestring
authority.​internalboolean
authority.​permissionsArray of strings
Items Enum"BACKOFFICE_LOGIN""LOCAL_MANAGER_LOGIN""APP_LOGIN""FORKLIFT_APP_LOGIN""OPERATIONAL_APP_LOGIN""ROLE_MANAGEMENT""LOCAL_MANAGER_REMOTE_ACCESS""USER_MANAGEMENT_READ""USER_MANAGEMENT_WRITE""AGENT_MANAGEMENT_READ"
phoneNumberstring

User's phone number

Example: "+1234567890"
passwordstring

User's password

Get authorities

Request

Security
X-AUTH-KEY
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/authority \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*Array [
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

authorityNamestring
]

Reset user password

Request

Security
X-AUTH-KEY
Path
uuidstringrequired
curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/user/{uuid}/reset-password' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Audit Log

Operations

Alert Events

Operations

Calibration Integration

External API for integration systems with token-based authentication

Operations

Bulk Upsert Management

Operations
Copyright 2026 Zimark Inc © All rights reserved.