Skip to content

Zimark Integration API (v1)

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

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

https://api.zimark-staging.link/

https://api.zimark.link/

User

Operations

Update user

Request

Security
X-AUTH-KEY
Path
uuidstringrequired
Bodyapplication/jsonrequired
firstNamestring[ 2 .. 100 ] charactersrequired
lastNamestring[ 2 .. 100 ] charactersrequired
emailstring^[_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)
firstNamestring[ 2 .. 100 ] charactersrequired

User's first name

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

User's last name

Example: "Doe"
emailstring^[_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.​authorityNamestring
authority.​internalboolean
authority.​permissionsArray of strings
Items Enum"BACKOFFICE_LOGIN""LOCAL_MANAGER_LOGIN""APP_LOGIN""OPERATIONAL_APP_LOGIN""ROLE_MANAGEMENT""LOCAL_MANAGER_REMOTE_ACCESS""USER_MANAGEMENT_READ""USER_MANAGEMENT_WRITE""AGENT_MANAGEMENT_READ""AGENT_MANAGEMENT_WRITE"
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
emailstring^[_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)
firstNamestring[ 2 .. 100 ] charactersrequired

User's first name

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

User's last name

Example: "Doe"
emailstring^[_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.​authorityNamestring
authority.​internalboolean
authority.​permissionsArray of strings
Items Enum"BACKOFFICE_LOGIN""LOCAL_MANAGER_LOGIN""APP_LOGIN""OPERATIONAL_APP_LOGIN""ROLE_MANAGEMENT""LOCAL_MANAGER_REMOTE_ACCESS""USER_MANAGEMENT_READ""USER_MANAGEMENT_WRITE""AGENT_MANAGEMENT_READ""AGENT_MANAGEMENT_WRITE"
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)
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

Manifest

Operations

Track

Operations

Printing Batch

Operations

Calibration Integration

Operations

Scanner

Operations

Local Manager

Operations

Gate

Operations

Audit Log

Operations

Alert Events

Operations

Agent

Operations
Copyright 2025 Zimark Inc © All rights reserved.