Get company by ID

GET 
/api/inspect/v1/company/:id

Fetch a company that the user has access to with the ID of the company.

Request

Path Parameters

id stringrequired

ID of the company to fetch

Responses

200

200 response

application/json

Schema

Schema

data

object

A business entity hosting the asset health data on screening eagle inspect platform

pictureURL uri

URL to the company logo

updatedBy int64

ID of the user who last updated the company

owner int64

User ID of the company owner

createdBy int64

ID of the user who created the company

id uuid

Unique identifier (ID) for the company

name string

Name of the company

regionalEndpoint uri

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.

updatedAt int64

Timestamp when the company was last updated in milliseconds

createdAt int64

Timestamp when the company was created in milliseconds

Example (from schema)

{
  "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

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

error string

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

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.

Example (from schema)

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

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

error string

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

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.

Example (from schema)

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

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

error string

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

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.

Example (from schema)

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

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

error string

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

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.

Example (from schema)

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

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

error string

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

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.

Example (from schema)

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

Loading...