Get company list
GET/api/inspect/v1/company
Fetch the list of companies that the user has access to, including their own company and any companies to which they have been invited for collaboration.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
200 response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
The list of companies.
URL to the company logo
ID of the user who last updated the company
User ID of the company owner
ID of the user who created the company
Unique identifier (ID) for the company
Name of the company
Possible values: [https://eu-dev-io.screeningeagle.com
, https://jp-dev-io.screeningeagle.com
, https://sg-dev-io.screeningeagle.com
, https://uk-dev-io.screeningeagle.com
, https://us-dev-io.screeningeagle.com
]
Regional endpoint for the company. This endpoint is used to access the regional data of the company like assets, spots, etc.
Timestamp when the company was last updated in milliseconds
Timestamp when the company was created in milliseconds
{
"data": [
{
"pictureURL": "string",
"updatedBy": 1413,
"owner": 0,
"createdBy": 1413,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"regionalEndpoint": "https://eu-dev-io.screeningeagle.com",
"updatedAt": 1652933097739,
"createdAt": 1652933097739
}
]
}
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
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
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": "Forbidden",
"errorDescription": "permission denied"
}
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
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
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": "Forbidden",
"errorDescription": "permission denied"
}
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
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
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": "Forbidden",
"errorDescription": "permission denied"
}
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
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
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": "Forbidden",
"errorDescription": "permission denied"
}
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
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
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": "Forbidden",
"errorDescription": "permission denied"
}