Company Users API

Managing company users (staff) — retrieval, creation, login and password change

Base URL

https://{tenant}.logzi.com/api/company_user/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/company_user/get

Retrieve a single user by identifier or username.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the user
usernamestringCan also be retrieved by username

Example request

GET /api/company_user/get?id=3
X-API-KEY: {your_api_key}
GET /api/company_user/list

Retrieve a paginated list of users with filtering options.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionarrayArray of filter conditions

Example request

GET /api/company_user/list?list_offset=0
X-API-KEY: {your_api_key}
POST /api/company_user/save

Create or update a user, including permissions and access settings. For a new user, use data[id] = 0.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new user, >0 = update
company_idintCompany identifier
usernamestringLogin username
password_new1stringPassword (required for a new user)
password_new2stringPassword confirmation (required for a new user)
default_store_idintDefault warehouse identifier
superior_company_user_idintSupervisor's user identifier
company_user_store_checkedarrayList of allowed warehouse IDs
company_user_paymod_checkedarrayList of allowed payment method IDs
company_user_cash_stock_checkedarrayList of allowed cash stock IDs

Example request

POST /api/company_user/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "username": "kiss.janos",
    "password_new1": "titkos123",
    "password_new2": "titkos123",
    "default_store_id": 1
  }
}
POST /api/company_user/delete

Delete a user by identifier.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the user to delete

Example request

POST /api/company_user/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 3 } }
POST /api/company_user/save_interface

Save user interface settings for the given user.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the user

Example request

POST /api/company_user/save_interface
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 3 } }
GET /api/company_user/login

Verify a user's login credentials (username + password pair). On success, returns the user's data.

Query parameters

ParameterTypeRequiredDescription
usernamestringLogin username
passwordstringPassword

Example request

GET /api/company_user/login?username=kiss.janos&password=titkos123
X-API-KEY: {your_api_key}
POST /api/company_user/save_password

Change a user's password.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the user
password_new1stringNew password
password_new2stringNew password confirmation

Example request

POST /api/company_user/save_password
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 3,
    "password_new1": "ujtitkos456",
    "password_new2": "ujtitkos456"
  }
}

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!