Sinai Technologies Organization management API
The Organization management API from Sinai Technologies — 20 operation(s) for organization management.
The Organization management API from Sinai Technologies — 20 operation(s) for organization management.
openapi: 3.1.0
info:
title: SINAI Baseline forecasts Organization management API
description: The SINAI application API
version: 1.0.0
contact:
name: API Support
url: https://help.sinai.com/en/
email: support@sinai.com
servers:
- url: https://api.sinai.com/
description: Production server
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- https://api.sinai.com/carbon_accounting
- https://api.sinai.com/baseline_forecasts
- https://api.sinai.com/transition_plan
- https://api.sinai.com/reduction_projects
- https://api.sinai.com/decarbonization_roadmap
- OAuth2AuthCodeProduction: []
tags:
- name: Organization management
paths:
/v1/organization/reporting_months:
get:
summary: Get reporting months for a given calendar or fiscal year
tags:
- Organization management
description: 'Use this endpoint to get a list of all the reporting months for a given calendar or fiscal year. If you ask for calendar year 2024, you will be given "2024-01", "2024-02", ..., "2024-12".
'
operationId: getReportingMonths
x-eov-operation-handler: organization/reportingMonths
parameters:
- name: fiscal_year
in: query
description: Get reporting months for a specific fiscal year, using the organization's fiscal start month setting
required: false
schema:
$ref: '#/components/schemas/Year'
- name: calendar_year
in: query
description: Get reporting months for a specific calendar year
required: false
schema:
$ref: '#/components/schemas/Year'
responses:
'200':
description: Reporting months for a given calendar or fiscal year retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Month'
'400':
$ref: '#/components/responses/UserInputError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/organization:
get:
summary: Retrieve the current organization
tags:
- Organization management
description: Use this endpoint to get the organization details.
operationId: getCurrentOrganization
x-eov-operation-handler: organization/organizations
responses:
'200':
description: Organization retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/functional_units:
get:
summary: List functional units
tags:
- Organization management
description: 'Use this endpoint to get a list of all functional units. If not filter is provided, only the functional units that are not industry-specific will be returned.
'
operationId: getFunctionalUnits
x-eov-operation-handler: organization/functionalUnits
parameters:
- name: sub_industry_code
in: query
description: 'Include functional units for this sub-industry configured. This is an additive filter.
'
required: false
schema:
$ref: '#/components/schemas/IndustryTaxonomySubIndustryCode'
responses:
'200':
description: Functional units retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FunctionalUnit'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
post:
summary: Create a functional unit
tags:
- Organization management
description: Use this endpoint to create a new functional unit.
operationId: createFunctionalUnit
x-eov-operation-handler: organization/functionalUnits
requestBody:
description: The functional unit to create
content:
application/json:
schema:
type: object
required:
- name
- defaultDisplayUnit
properties:
name:
type: string
description: The name of the functional unit
description:
type: string
description: The description of the functional unit
defaultDisplayUnit:
$ref: '#/components/schemas/Unit'
description: The default display unit for the functional unit
subIndustryCode:
$ref: '#/components/schemas/NullableIndustryTaxonomySubIndustryCode'
description: The sub-industry code of the functional unit
measurementType:
$ref: '#/components/schemas/FunctionalUnitMeasurementType'
description: The type of measurement of the functional unit
responses:
'201':
description: Functional unit created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/FunctionalUnit'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/functional_units/{id}:
get:
summary: Retrieve a functional unit by its ID
tags:
- Organization management
description: Use this endpoint to get a specific functional unit by its ID.
operationId: getFunctionalUnit
x-eov-operation-handler: organization/functionalUnits
parameters:
- name: id
in: path
description: The ID of the functional unit
required: true
schema:
$ref: '#/components/schemas/FunctionalUnitID'
responses:
'200':
description: Functional unit retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/FunctionalUnit'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/industry_taxonomy/sectors:
get:
summary: List industry taxonomy sectors
tags:
- Organization management
description: Use this endpoint to get a list of industry taxonomy sectors.
operationId: getSectors
x-eov-operation-handler: organization/industryTaxonomy
responses:
'200':
description: Industry taxonomy sectors retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IndustryTaxonomySector'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/industry_taxonomy/industry_groups:
get:
summary: List industry taxonomy industry groups
tags:
- Organization management
description: Use this endpoint to get a list of industry taxonomy industry groups.
operationId: getIndustryGroups
x-eov-operation-handler: organization/industryTaxonomy
parameters:
- name: sector_code
in: query
description: filter industry groups by this sector code
required: false
schema:
$ref: '#/components/schemas/IndustryTaxonomySectorCode'
responses:
'200':
description: Industry taxonomy industry groups retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IndustryTaxonomyIndustryGroup'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/industry_taxonomy/industries:
get:
summary: List industry taxonomy industries
tags:
- Organization management
description: Use this endpoint to get a list of industry taxonomy industries.
operationId: getIndustries
x-eov-operation-handler: organization/industryTaxonomy
parameters:
- name: industry_group_code
in: query
description: filter industries by this industry group code
required: false
schema:
$ref: '#/components/schemas/IndustryTaxonomyIndustryGroupCode'
responses:
'200':
description: Industry taxonomy industries retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IndustryTaxonomyIndustry'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/industry_taxonomy/sub_industries:
get:
summary: List industry taxonomy sub-industries
tags:
- Organization management
description: Use this endpoint to get a list of industry taxonomy sub-industries.
operationId: getSubIndustries
x-eov-operation-handler: organization/industryTaxonomy
parameters:
- name: industry_code
in: query
description: filter sub-industries by this industry code
required: false
schema:
$ref: '#/components/schemas/IndustryTaxonomyIndustryCode'
responses:
'200':
description: Industry taxonomy sub-industries retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IndustryTaxonomySubIndustry'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/business_entities/{id}:
get:
summary: Retrieve a business entity by its ID
tags:
- Organization management
description: Use this endpoint to get a specific business entity by its ID.
operationId: getBusinessEntity
x-eov-operation-handler: organization/businessEntities
parameters:
- name: id
in: path
description: The unique identifier for the business entity
required: true
schema:
$ref: '#/components/schemas/BusinessEntityID'
responses:
'200':
description: Business entity retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessEntity'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
put:
summary: Update a business entity
tags:
- Organization management
description: This endpoint updates the details of a specified business entity in the system.
operationId: updateBusinessEntity
x-eov-operation-handler: organization/businessEntities
parameters:
- name: id
in: path
required: true
description: The unique identifier of the business entity to be updated.
schema:
$ref: '#/components/schemas/BusinessEntityID'
requestBody:
description: The new business entity details to be updated.
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
example: New business entity name
description: The new name of the business entity.
description:
type: string
example: This is an updated description for the business entity.
description: The new description of the business entity.
responses:
'200':
description: Business entity successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessEntity'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
delete:
summary: Delete a business entity
tags:
- Organization management
description: This endpoint deletes a specified business entity from the system.
operationId: deleteBusinessEntity
x-eov-operation-handler: organization/businessEntities
parameters:
- name: id
in: path
required: true
description: The unique identifier of the business entity to be deleted.
schema:
$ref: '#/components/schemas/BusinessEntityID'
responses:
'204':
description: Business entity successfully deleted
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/business_entities/{id}/descendants:
get:
summary: Retrieve all descendants of a business entity
tags:
- Organization management
description: 'Use this endpoint to get all the business entities that are descendants of the entity specified by the ID. Descendants include children of a business entities and also the children of those children.
'
operationId: getBusinessEntityDescendants
x-eov-operation-handler: organization/businessEntities
parameters:
- name: id
in: path
description: The unique identifier for the business entity
required: true
schema:
$ref: '#/components/schemas/BusinessEntityID'
- name: business_entity_type_id
in: query
description: filter entities by this type id
required: false
schema:
$ref: '#/components/schemas/BusinessEntityTypeID'
- name: business_entity_type_category
in: query
description: filter entities by this type category
required: false
schema:
$ref: '#/components/schemas/BusinessEntityTypeCategory'
responses:
'200':
description: Business entity retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessEntity'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/business_entities:
post:
summary: Create a new business entity
tags:
- Organization management
description: This endpoint creates a new business entity.
operationId: createBusinessEntity
x-eov-operation-handler: organization/businessEntities
requestBody:
content:
application/json:
schema:
type: object
properties:
parentID:
$ref: '#/components/schemas/BusinessEntityID'
description: The ID of the parent business entity.
name:
type: string
example: New Business Entity
description: The name of the new business entity.
description:
type: string
example: Description of the new business entity.
description: The description of the new business entity.
countryCode:
$ref: '#/components/schemas/CountryCode'
description: The country code of the new business entity.
subIndustryCode:
$ref: '#/components/schemas/IndustryTaxonomySubIndustryCode'
description: The sub-industry code of the new business entity.
facilityTypeID:
$ref: '#/components/schemas/NullableFacilityTypeID'
description: The facility type of the new business entity.
processTypeID:
$ref: '#/components/schemas/NullableProcessTypeID'
description: The process type of the new business entity.
businessEntityTypeID:
$ref: '#/components/schemas/BusinessEntityTypeID'
description: The type of business entity to create.
defaultFunctionalUnitID:
$ref: '#/components/schemas/FunctionalUnitID'
description: The default functional unit for the new business entity.
customFunctionalUnitName:
type: string
description: 'The name of the custom functional unit for the business entity. If you want to define a custom functional unit for the business entity, make sure to set this parameter.
'
defaultDisplayUnit:
type: string
description: 'The default display unit for the functional unit of the business entity. If you want to define a custom functional unit for the business entity, make sure to set this parameter.
'
activeStartTimestamp:
type: number
description: The timestamp when the business entity becomes active, in milliseconds since epoch.
activeEndTimestamp:
type: number
description: The timestamp when the business entity becomes inactive, in milliseconds since epoch.
required:
- parentID
- name
- businessEntityTypeID
responses:
'201':
description: Business entity successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessEntity'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
get:
summary: List business entities in an org
tags:
- Organization management
description: Use this endpoint to get a list of business entities that meet a specific filtering criteria.
operationId: getBusinessEntities
x-eov-operation-handler: organization/businessEntities
parameters:
- name: business_entity_type_id
in: query
description: filter entities by this type id
required: false
schema:
$ref: '#/components/schemas/BusinessEntityTypeID'
- name: business_entity_type_category
in: query
description: filter entities by this type category
required: false
schema:
$ref: '#/components/schemas/BusinessEntityTypeCategory'
responses:
'200':
description: the list of business entities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessEntity'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/business_entity_types:
get:
summary: List business entity types
tags:
- Organization management
description: Use this endpoint to get a list of business entity types.
operationId: getBusinessEntityTypes
x-eov-operation-handler: organization/businessEntityTypes
responses:
'200':
description: The list of business entity types
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessEntityType'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/facility_types:
get:
summary: List facility types
tags:
- Organization management
description: Use this endpoint to get a list of facility types.
operationId: getFacilityTypes
x-eov-operation-handler: organization/facilityTypes
parameters:
- name: sub_industry_code
in: query
description: 'Filter facility types by sub industry code. This is an additive filter; if specified, facility types with a sub industry code that matches the provided code will be returned in addition to facility types that do not have a sub industry code.
'
required: false
schema:
$ref: '#/components/schemas/IndustryTaxonomySubIndustryCode'
responses:
'200':
description: The list of facility types
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FacilityType'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/process_types:
get:
summary: List process types
tags:
- Organization management
description: Use this endpoint to get a list of process types.
operationId: getProcessTypes
x-eov-operation-handler: organization/processTypes
parameters:
- name: facility_type_id
in: query
description: Filter process types by facility type ID
required: false
schema:
$ref: '#/components/schemas/FacilityTypeID'
responses:
'200':
description: The list of process types
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProcessType'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/emissions_sources/{id}:
get:
summary: Retrieve an emissions source by its ID
tags:
- Organization management
description: Use this endpoint to get a specific emissions source by its ID.
operationId: getEmissionsSource
x-eov-operation-handler: organization/emissionsSources
parameters:
- name: id
in: path
description: The unique identifier for the emissions source
required: true
schema:
$ref: '#/components/schemas/EmissionsSourceID'
responses:
'200':
description: Emissions source retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/EmissionsSource'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
put:
summary: Update an emissions source
tags:
- Organization management
description: Updates an existing emissions source with new details.
operationId: updateEmissionsSource
x-eov-operation-handler: organization/emissionsSources
parameters:
- name: id
in: path
required: true
description: The unique identifier of the emissions source to be updated
schema:
$ref: '#/components/schemas/EmissionsSourceID'
requestBody:
description: The updated emissions source details
content:
application/json:
schema:
type: object
required:
- processID
- emissionsSourceTypeID
- emissionsModelID
properties:
processID:
$ref: '#/components/schemas/BusinessEntityID'
description: The id of the process business entity this emissions source belongs to
emissionsSourceTypeID:
$ref: '#/components/schemas/EmissionsSourceTypeID'
description: The type of emissions source this emissions source represents
emissionsModelID:
$ref: '#/components/schemas/EmissionsModelID'
description: The id of the emissions model used to compute the emissions
relatedSourceID:
$ref: '#/components/schemas/EmissionsSourceID'
description: ID of a related emissions source
scope:
$ref: '#/components/schemas/EmissionsScope'
description: The GHG protocol scope this source belongs to
status:
$ref: '#/components/schemas/EmissionsSourceStatus'
description: The status of this emissions source
description:
type: string
description: A description of what this emissions source represents
referenceSourceIDs:
type: array
items:
$ref: '#/components/schemas/EmissionsSourceID'
description: List of reference emissions source IDs
responses:
'200':
description: Emissions source successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/EmissionsSource'
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
delete:
summary: Delete an emissions source
tags:
- Organization management
description: Deletes an emissions source and all emissions activity data associated with it.
operationId: deleteEmissionsSource
x-eov-operation-handler: organization/emissionsSources
parameters:
- name: id
in: path
required: true
description: The unique identifier of the emissions source to be deleted
schema:
$ref: '#/components/schemas/EmissionsSourceID'
responses:
'204':
description: Emissions source successfully deleted
'403':
$ref: '#/components/responses/ForbiddenError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/emissions_sources:
post:
summary: Create a new emissions source
tags:
- Organization management
description: Creates a new emissions source under the specified business entity process.
operationId: createEmissionsSource
x-eov-operation-handler: organization/emissionsSources
requestBody:
content:
application/json:
schema:
type: object
required:
- processID
- emissionsSourceTypeID
- emissionsModelID
properties:
processID:
$ref: '#/components/schemas/BusinessEntityID'
description: The id of the process business entity this emissions source belongs to
emissionsSourceTypeID:
$ref: '#/components/schemas/EmissionsSourceTypeID'
description: The type of emissions source this emissions source represents.
emissionsModelID:
$ref: '#/components/schemas/EmissionsModelID'
description: The id of the emissions model used to compute the emissions of this emissions source
relatedSourceID:
$ref: '#/components/schemas/EmissionsSourceID'
scope:
$ref: '#/components/schemas/EmissionsScope'
status:
$ref: '#/components/schemas/EmissionsSourceStatus'
description:
type: string
description: A description of what this emissions source represents
referenceSourceIDs:
type: array
items:
$ref: '#/components/schemas/EmissionsSourceID'
responses:
'201':
description: The newly created emissions source
content:
application/json:
schema:
$ref: '#/components/schemas/EmissionsSource'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
get:
summary: List emissions sources in an org
tags:
- Organization management
description: 'Use this endpoint to get a list of emissions sources in the organization. If no filters are specified, all emissions sources in the organization are returned. You can optionally filter the results by process ID or business entity ID.
'
operationId: getEmissionsSources
x-eov-operation-handler: organization/emissionsSources
parameters:
- name: process_id
in: query
description: Filter emissions sources by process ID
required: false
schema:
$ref: '#/components/schemas/BusinessEntityID'
- name: business_entity_id
in: query
description: 'Filter emissions sources by business entity ID. This will return all emissions sources that are descendants of the specified business entity.
'
required: false
schema:
$ref: '#/components/schemas/BusinessEntityID'
- name: emissions_source_type_id
in: query
description: Filter emissions sources by source type ID
required: false
schema:
$ref: '#/components/schemas/EmissionsSourceTypeID'
responses:
'200':
description: The list of emissions sources
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EmissionsSource'
'400':
$ref: '#/components/responses/UserInputError'
security:
- OAuth2ClientCredentialsProduction:
- https://api.sinai.com/organization
- OAuth2AuthCodeProduction: []
/v1/organization/emissions_source_types/{id}:
get:
summary: Retrieve an emissions source type by its ID
tags:
- Organization management
description: Use this endpoint to get a specific emissions source type by its ID.
operationId: getEmissionsSourceType
x-eov-operation-handler: organization/emissionsSourceTypes
parameters:
- n
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sinai-technologies/refs/heads/main/openapi/sinai-technologies-organization-management-api-openapi.yml