SIsinai
Organization management

List business entities in an org

Use this endpoint to get a list of business entities that meet a specific filtering criteria.

get/v1/organization/business_entities

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
    A function with typed inputs. Its response is checked against the schema.

Query parameters

business_entity_type_idstring uuid

filter entities by this type id

business_entity_type_category'ORG_LEVEL' | 'MID_LEVEL' | 'FACILITY_LEVEL' | 'PROCESS_LEVEL'

filter entities by this type category

Response

the list of business entities

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

Example response

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

Changes

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