Contents x
    Retrieve Organization using OrgCode
    • 04 Nov 2025
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Retrieve Organization using OrgCode

    • Updated on 04 Nov 2025
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /om-rest-api/rest/1/organization/

    Overview

    This endpoint retrieves Organization (OM-only) records from CMiC’s core data model.
    Organizations represent business entities that exist only in the Opportunity Management (OM) layer and are not exposed as standard Business Partners.
    Use this API to query, search, or display organizations that have been flagged as OM-only (OMO_OM_ONLY_FLAG = 'Y').
    These organizations are typically used for CRM, sales tracking, and opportunity management, separate from active vendor or customer partners.

    UI Navigation

    Customer Relationship Management - Opportunity Management - Organizations

    Finders

    The following finders are available for data filtering and optimizing request performance.

    • SelectByOrgCode

    Path Parameters

    ParameterDescriptionExample
    OrgCodeOrganization CodeSP01

    Query Standards

    KeyRecommendedDescription
    finderYesFilters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality, please see [Best Practice
    limitYesA limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality, please visit [Best Practice
    offsetYesThe offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using offset functionality, please visit [Best Practice
    orderByYesThe orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality, please visit [Best Practice

    Attributes

    CMiC UI FieldnameObjectNameDescriptionTypeData LengthExampleMandatory
    OmoOrgCodeorganizationOmoOrgCodeOrganization / Business Partner CodeString8CANPLUMTrue
    OmoNameorganizationOmoNameOrganization NameString50TEST VENDORFalse
    OmoAkaNameorganizationOmoAkaNameAlso Known As NameString50nullFalse
    OmoShortNameorganizationOmoShortNameShort Name of the OrganizationString15Canadian PlumbiFalse
    OmoParentCodeorganizationOmoParentCodeControlling Business Partner CodeString8nullFalse
    OmoParentNameorganizationOmoParentNameControlling Business Partner NameString50nullFalse
    OmoAdd1organizationOmoAdd1Address Line 1String40oneFalse
    OmoAdd2organizationOmoAdd2Address Line 2String40nullFalse
    OmoAdd3organizationOmoAdd3Address Line 3String40BernabeuFalse
    OmoRegionCodeorganizationOmoRegionCodeState / Region CodeString4ONTFalse
    OmoCountryorganizationOmoCountryCountry NameString30nullFalse
    OmoPostalCodeorganizationOmoPostalCodeZip / Postal CodeString13nullFalse
    OmoPhone1organizationOmoPhone1Primary Phone NumberString20nullFalse
    OmoPhone2organizationOmoPhone2Secondary Phone NumberString204156456False
    OmoPhone3organizationOmoPhone3Alternate Phone NumberString20nullFalse
    OmoEmailorganizationOmoEmailEmail AddressString80nullFalse
    OmoStartDateorganizationOmoStartDateStart Date of the OrganizationStringN/A2010-02-26False
    OmoLegalentTypeCodeorganizationOmoLegalentTypeCodeLegal Entity Type CodeString5CORPFalse
    OmoRegistrationCodeorganizationOmoRegistrationCodeGovernment Registration CodeString3033229988False
    OmoCreateUserorganizationOmoCreateUsercreated the User recordString30DAFalse
    OmoWebSiteorganizationOmoWebSiteOrganization WebsiteString200nullFalse
    OmoOneTimeFlagorganizationOmoOneTimeFlagOne-Time Partner FlagString1NFalse
    OmoClassCodeorganizationOmoClassCodePartner Class CodeString4SUBFalse
    OmoClassNameorganizationOmoClassNamePartner Class NameString30SubcontractorFalse
    Omo1099CodeorganizationOmo1099Code1099 Tax CodeString13False
    OmoAbbrevCodeorganizationOmoAbbrevCodeAbbreviation Code for the PartnerString8CANPLUMTrue
    OmoSalesRepCodeorganizationOmoSalesRepCodeSales Representative CodeString10QQFalse
    OmoSalesRepNameorganizationOmoSalesRepNameSales Representative NameString121qn qnFalse
    OmoSourceCodeorganizationOmoSourceCodeSource CodeString8ACM11False
    OmoSourceNameorganizationOmoSourceNameSource NameString30ACM Conference 2011False
    OmoSalesRepPartnTypeCodeorganizationOmoSalesRepPartnTypeCodeSales RepString1CFalse
    OmoSaleRepPartnNameorganizationOmoSaleRepPartnNameSales Representative’s Company NameString30JHP Construction, Inc.False
    OmoTypeCodeorganizationOmoTypeCodeBusiness Partner Type CodeString1OFalse
    OmoTypeNameorganizationOmoTypeNameBusiness Partner Relationship TypeString16OrganizationFalse
    OmoPrimaryContactNameorganizationOmoPrimaryContactNamePrimary Contact Person NameString121nullFalse
    OmoPrimaryContactPhoneorganizationOmoPrimaryContactPhonePrimary Contact Phone NumberString100nullFalse
    OmoOmOnlyFlagorganizationOmoOmOnlyFlagOpportunity Management Only IndicatorString1YFalse
    OmoActiveFlagorganizationOmoActiveFlagActive Status FlagString1YFalse
    OmoLegalNameorganizationOmoLegalNameLegal Registered NameString255BP 1111False
    OmoSsnFlagorganizationOmoSsnFlagSSN FlagString1NFalse
    OmoPrevClientorganizationOmoPrevClientPrevious Client FlagString8nullFalse
    OmoTopXAcctorganizationOmoTopXAcctTop X Account FlagString1nullFalse
    OmoNatacctFlagorganizationOmoNatacctFlagNational Account FlagString1nullFalse
    OmoEthicsPolicyorganizationOmoEthicsPolicyEthics Policy IndicatorString1nullFalse
    OmoCustomerFlagorganizationOmoCustomerFlagCustomer Status FlagString1NFalse
    OmoVendorFlagorganizationOmoVendorFlagVendor Status FlagString1NFalse
    OmoClvValueCode1organizationOmoClvValueCode1Classification Value Code 1String1681SBFalse
    OmoClvValueCode2organizationOmoClvValueCode2Classification Value Code 2String16nullFalse
    OmoClvValueCode3organizationOmoClvValueCode3Classification Value Code 3String16nullFalse
    OmoClvValueCode4organizationOmoClvValueCode4Classification Value Code 4String16nullFalse
    OmoClvValueCode5organizationOmoClvValueCode5Classification Value Code 5String16nullFalse
    OmoClvValueCode6organizationOmoClvValueCode6Classification Value Code 6String16YesFalse
    OmoVUuidorganizationOmoVUuidUnique Identifier (Primary Key for API)String64A01EEB05042D8EE9E0536900A8C052C6False
    OmoIuCreateDateorganizationOmoIuCreateDateRecord Create DateDate2010-02-26T08:22:17-05:00False
    OmoIuUpdateDateorganizationOmoIuUpdateDateRecord Last Update DateDate2025-10-09T12:53:23-04:00False
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExampleSelectByOrgCode;orgCode=SP01
    limit
    integer
    Example500
    offset
    integer
    Example0
    Responses
    200

    OK

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourcecollection+json
    "{\n    \"items\": [\n        {\n            \"Omo1099Code\": null,\n            \"OmoAbbrevCode\": \"SP01\",\n            \"OmoActiveFlag\": \"Y\",\n            \"OmoAdd1\": \"3000 Commerical Blvd.\",\n            \"OmoAdd2\": \"201\",\n            \"OmoAdd3\": \"Fort Lauderdale\",\n            \"OmoAkaName\": null,\n            \"OmoClassCode\": null,\n            \"OmoClassName\": null,\n            \"OmoClvValueCode1\": null,\n            \"OmoClvValueCode2\": null,\n            \"OmoClvValueCode3\": null,\n            \"OmoClvValueCode4\": null,\n            \"OmoClvValueCode5\": null,\n            \"OmoClvValueCode6\": null,\n            \"OmoCountry\": null,\n            \"OmoCreateUser\": \"DA\",\n            \"OmoCustomerFlag\": \"N\",\n            \"OmoEmail\": null,\n            \"OmoEthicsPolicy\": null,\n            \"OmoIuCreateDate\": \"2014-01-16T16:24:11-05:00\",\n            \"OmoIuUpdateDate\": \"2018-03-09T10:40:19-05:00\",\n            \"OmoLegalName\": \"SP ORGANIZATION / NEW CUSTOMER\",\n            \"OmoLegalentTypeCode\": null,\n            \"OmoName\": \"SP ORGANIZATION / NEW CUSTOMER\",\n            \"OmoNatacctFlag\": null,\n            \"OmoObjectOraseq\": 3527020,\n            \"OmoOmOnlyFlag\": \"Y\",\n            \"OmoOneTimeFlag\": \"N\",\n            \"OmoOrgCode\": \"SP01\",\n            \"OmoParentCode\": null,\n            \"OmoParentName\": null,\n            \"OmoPhone1\": null,\n            \"OmoPhone2\": null,\n            \"OmoPhone3\": null,\n            \"OmoPostalCode\": \"33010\",\n            \"OmoPrevClient\": null,\n            \"OmoPrimaryContactName\": null,\n            \"OmoPrimaryContactPhone\": null,\n            \"OmoRegionCode\": \"FL\",\n            \"OmoRegistrationCode\": null,\n            \"OmoSaleRepPartnName\": null,\n            \"OmoSalesRepCode\": null,\n            \"OmoSalesRepName\": null,\n            \"OmoSalesRepPartnTypeCode\": null,\n            \"OmoShortName\": \"SP ORGANIZATION\",\n            \"OmoSourceCode\": \"EXISTING\",\n            \"OmoSourceName\": \"Existing Relationship\",\n            \"OmoSsnFlag\": \"N\",\n            \"OmoStartDate\": \"2014-01-16T16:24:11-05:00\",\n            \"OmoTopXAcct\": null,\n            \"OmoTypeCode\": \"O\",\n            \"OmoTypeName\": \"Organization\",\n            \"OmoVUuid\": \"A01EEB0505F18EE9E0536900A8C052C6\",\n            \"OmoVendorFlag\": \"N\",\n            \"OmoWebSite\": null,\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://127.0.0.1:7101/om-rest-api/rest/1/organization/A01EEB0505F18EE9E0536900A8C052C6\",\n                    \"name\": \"organization\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://127.0.0.1:7101/om-rest-api/rest/1/organization/A01EEB0505F18EE9E0536900A8C052C6\",\n                    \"name\": \"organization\",\n                    \"kind\": \"item\"\n                }\n            ]\n        }\n    ],\n    \"count\": 1,\n    \"hasMore\": false,\n    \"limit\": 25,\n    \"offset\": 0,\n    \"links\": [\n        {\n            \"rel\": \"self\",\n            \"href\": \"http://127.0.0.1:7101/om-rest-api/rest/1/organization\",\n            \"name\": \"organization\",\n            \"kind\": \"collection\"\n        }\n    ]\n}"
    string
    What's Next
    Contact Us
    Copyright © 2024 CMiC All Rights Reserved