Get user list by company

GET 
/api/inspect/v1/user

Fetch the list of users in a company.

Request

Query Parameters

companyID stringrequired

Company ID for which users are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object[]

The list of users.

Array [

pictureURL uri

URL of the user's profile picture

role int32

Possible values: [0, 1, 6, 2, 3, 5]

Role of the user. 0 = Normal, 1 = Owner, 6 = Admin, 2 = Manager, 3 = Inspector, 5 = Viewer

active boolean

Whether the user is active

email email

Email address of the user

firstName string

First name of the user

id int64

Unique identifier (ID) for the user

lastName string

Last name of the user

]

Example (from schema)

{
  "data": [
    {
      "pictureURL": "https://example.com/user.jpg",
      "role": 1,
      "active": true,
      "email": "user@example.com",
      "firstName": "John",
      "id": 1413,
      "lastName": "Doe"
    }
  ]
}

400

400 Bad Request. The request is invalid. This may occur if required parameters are missing or invalid. Ensure that all required parameters are included and valid.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

401

401 Unauthorized. Authentication is required and was not provided or is invalid. Ensure that the correct credentials or tokens are included in the request.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

403

403 Forbidden. The client does not have permission to perform this action. This might happen if the client lacks the necessary privileges to interact with the specified entity.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

404

404 Not Found. The specified entity does not exist. Verify that the reference given is correct and that the entity is available.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

500

500 Internal Server Error. An error occurred on the server while processing the request. Retry the operation or contact support if the issue persists.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

Loading...