Organization management

Retrieve a business entity by its ID

Use this endpoint to get a specific business entity by its ID.

get/v1/organization/business_entities/{id}

Request

Base URL
https://api.sinai.com
Auth
- OAuth 2
  Client credentials
  Token URLhttps://auth.sinai.com/oauth2/token
  Scopeshttps://api.sinai.com/organization
- or OAuth 2
  Authorization codehttps://auth.sinai.com/oauth2/authorize
  Token URLhttps://auth.sinai.com/oauth2/token
TypeScript
https://skmtc.dev/sinai/apis/sinai-api/docs/v1/organization/business_entities/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

The unique identifier for the business entity

Business entity retrieved successfully

idstring uuid required

orgIDstring uuid

parentIDstring uuid nullable

namestring required

The name of the business entity

descriptionstring

A description of the business entity

countryCodestring

The country code of the business entity.

subIndustryCodestring nullable

The sub-industry code of the business entity or functional unit, formatted as eight digits.

facilityTypeIDstring uuid nullable

The facility type of the business entity if it is a facility.

processTypeIDstring uuid nullable

The process type of the business entity if it is a process.

businessEntityTypeIDstring uuid

defaultFunctionalUnitIDstring uuid

defaultDisplayUnitstring

The default display unit for the functional unit of the business entity

activeStartTimestampnumber

The timestamp when the business entity becomes active, in milliseconds since epoch

activeEndTimestampnumber

The timestamp when the business entity becomes inactive, in milliseconds since epoch

{
  "name": "Manufacturing plant",
  "description": "The building where things are manufactured"
}

No recorded changes to this operation across all 1 revision of this API.