Get Organization By Id
Version 1.0.0
Endpoint
GET
undefined/organization/{id}
Copy
Retrieves an organization using the CIMS Company ID. Filter Correlated IDs by Correlated Type.
http
scheme:bearer
Path Parameters
- idstringRequired
Query Parameters
- correlated_id_type
- FilterDropdownstringEnum: [ALL, NONE, DUNS, C-NODE, SAART_L2, SAART_L3]An enumeration.
Body Parameters
Responses
Successful Response
Body
application/json
- objectOrganization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. CIMS uses this Organization model to provide a single Company Identifier based on Company Name + Location uniqueness from sources like D&B.
- idstringRequiredCompany ID generated by CIMS. Unique identifier of the organization.Example: a8216bbf-fb08-48cd-982f-e238d3ecb828
- hrefstringHyperlink to access the organization.Example: https://cims-westus2-poc-cims-container-as.azurewebsites.net/organization/a8216bbf-fb08-48cd-982f-e238d3ecb828
- namestringOrganization/Business nameExample: Florida Department of Labor and Employment Security
- @typestring
- statusstringEnum: [initiated, validated, closed]Valid values for the lifecycle state of the organization.
- otherNamearray of objectsKeeps track of other names, for example the old name of an organization.
- tradingNamestringName that the organization (unit) trades under.Example: Bureau of Compliance
- isHeadOfficebooleanIf value is true, the organization is the head office i.e the Global Ultimate in D&B terms.
- existsDuringobjectA period of time, either as a deadline (endDateTime only) a startDateTime only, or both
- relatedPartyarray of objectsRelated Entity reference. A related party defines party or party role linked to a specific entity. One of the entities in the list contains the reference to the Global Ultimate/Root Organization in a structure of organizations.
- contactMediumarray of objectsIndicates the contact medium that could be used to contact the organization.
- organizationIdentificationarray of objectsRepresents our registration of information used as proof of identity by an organization.
- organizationChildRelationshiparray of objectsChild references of an organization in a structure of organizations.
- organizationParentRelationshipobjectParent reference of an organization in a structure of organizations.