Retrieve Contacts By Codes
  • 01 Oct 2025
  • 4 Minutes to read
  • Dark
    Light

Retrieve Contacts By Codes

  • Dark
    Light

Article summary

Get
/sys-rest-api/rest/1/syscontact

Get SysContact by Codes

This endpoint retrieves system contacts based on specified criteria.

Finder Name:

SysContactFinder

Request Parameters

  • ContactCode (query parameter) - The code of the contact.

  • Email1 (query parameter) - The email address of the contact.

  • EmpNo (query parameter) - The employee number.

  • ActiveFlag (query parameter) - Indicates whether the contact is active.

  • PartnCode (query parameter) - The partner code.

  • PartnTypeCode (query parameter) - The partner type code.

  • AuditDate (query parameter) - The audit date.

Response Body

The response will contain the details of the system contact in the JSON format. Here is an example of the response body:

{
    "SyscContactCode":"",
    "SyscFirstName":"",
    "SyscMiddleName":null,
    "SyscLastName":"",
    "SyscDisplayName":"",
    "SyscPrefixName":null,
    "SyscSuffixName":null,
    "SyscAkaName":null,
    "SyscEmpNo":null,
    "SyscContactDesc":null,
    "SyscAddCompCode":"",
    "SyscAddCode":"",
    "SyscAddLine1":null,
    "SyscAddLine2":null,
    "SyscAddLine3":null,
    "SyscRegionCode":null,
    "SyscPostalCode":null,
    "SyscCountry":null,
    "SyscWorkPhoneNum":"",
    "SyscHomePhoneNum":null,
    "SyscMobileNum":null,
    "SyscPagerNum":null,
    "SyscFaxNum1":"",
    "SyscFaxNum2":null,
    "SyscEmail1":"",
    "SyscEmail1Link":"",
    "SyscEmail2":null,
    "SyscEmail2Link":null,
    "SyscWwwSite":null,
    "SyscPmRoleCode":"",
    "SyscPmRoleName":"",
    "SyscOther":null,
    "SyscPrefContactMth":"",
    "SyscActiveFlag":"",
    "SyscPartnCode":"",
    "SyscPartnTypeCode":"",
    "SyscPartnName":"",
    "SyscPrimaryFlag":"",
    "SyscLastUpdUser":"",
    "SyscBidFlag":"",
    "SyscCollabUsagePrice":null,
    "SyscCollabUserFlag":"",
    "SyscPartnOmOnlyFlag":"",
    "SyscHtmlEmailFlag":"",
    "SyscIndepContractorFlag":"",
    "SyscVUuid":"",
    "SyscLastModifiedDate":"",
    "links":[{"rel":"","href":"","name":"","kind":""}]
}

Security
HTTP
Type basic

Basic authentication

Query parameters
limit
integer
Example25
offset
integer
Example0
totalResults
boolean
Exampletrue
finder
string
ExampleSysContactFinder; ContactCode = LME, Email1=leomessi@test.com,EmpNo = XYZ,ActiveFlag = Y, PartnCode = ZZ , PartnTypeCode = C, AuditDate=2025-05-12
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
  "items": [
    {
      "SyscContactCode": "IBER",
      "SyscFirstName": "Ibrahim",
      "SyscMiddleName": null,
      "SyscLastName": "Berjaoui",
      "SyscDisplayName": "Ibrahim Berjaoui",
      "SyscPrefixName": null,
      "SyscSuffixName": null,
      "SyscAkaName": null,
      "SyscEmpNo": null,
      "SyscContactDesc": null,
      "SyscAddCompCode": null,
      "SyscAddCode": null,
      "SyscAddLine1": null,
      "SyscAddLine2": null,
      "SyscAddLine3": null,
      "SyscRegionCode": null,
      "SyscPostalCode": null,
      "SyscCountry": null,
      "SyscWorkPhoneNum": null,
      "SyscHomePhoneNum": null,
      "SyscMobileNum": null,
      "SyscPagerNum": null,
      "SyscFaxNum1": null,
      "SyscFaxNum2": null,
      "SyscEmail1": null,
      "SyscEmail1Link": null,
      "SyscEmail2": null,
      "SyscEmail2Link": null,
      "SyscWwwSite": null,
      "SyscPmRoleCode": null,
      "SyscPmRoleName": null,
      "SyscOther": null,
      "SyscPrefContactMth": "MAIL",
      "SyscActiveFlag": "Y",
      "SyscPartnCode": "ZZ",
      "SyscPartnTypeCode": "C",
      "SyscPartnName": "CMiC-ZZ  Test Company Incorp",
      "SyscPrimaryFlag": "N",
      "SyscLastUpdUser": "DAR",
      "SyscBidFlag": "N",
      "SyscCollabUsagePrice": null,
      "SyscCollabUserFlag": "N",
      "SyscPartnOmOnlyFlag": "N",
      "SyscHtmlEmailFlag": "N",
      "SyscIndepContractorFlag": "N",
      "SyscVUuid": "166984346836F171E0630B811DAC4237",
      "SyscLastModifiedDate": "2025-05-13T17:23:23Z",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/166984346836F171E0630B811DAC4237",
          "name": "syscontact",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/166984346836F171E0630B811DAC4237",
          "name": "syscontact",
          "kind": "item"
        }
      ]
    },
    {
      "SyscContactCode": "JJC",
      "SyscFirstName": "JCA",
      "SyscMiddleName": null,
      "SyscLastName": "JCA",
      "SyscDisplayName": "JCA JCA",
      "SyscPrefixName": null,
      "SyscSuffixName": null,
      "SyscAkaName": null,
      "SyscEmpNo": null,
      "SyscContactDesc": null,
      "SyscAddCompCode": null,
      "SyscAddCode": null,
      "SyscAddLine1": null,
      "SyscAddLine2": null,
      "SyscAddLine3": null,
      "SyscRegionCode": null,
      "SyscPostalCode": null,
      "SyscCountry": null,
      "SyscWorkPhoneNum": "1 (416) 2258888",
      "SyscHomePhoneNum": null,
      "SyscMobileNum": null,
      "SyscPagerNum": null,
      "SyscFaxNum1": "1 (416) 5556658",
      "SyscFaxNum2": null,
      "SyscEmail1": "JCA@cmic.ca",
      "SyscEmail1Link": "JCA@cmic.ca",
      "SyscEmail2": null,
      "SyscEmail2Link": null,
      "SyscWwwSite": null,
      "SyscPmRoleCode": null,
      "SyscPmRoleName": null,
      "SyscOther": null,
      "SyscPrefContactMth": null,
      "SyscActiveFlag": "Y",
      "SyscPartnCode": "ZZ",
      "SyscPartnTypeCode": "C",
      "SyscPartnName": "CMiC-ZZ  Test Company Incorp",
      "SyscPrimaryFlag": "N",
      "SyscLastUpdUser": "DAR",
      "SyscBidFlag": "N",
      "SyscCollabUsagePrice": null,
      "SyscCollabUserFlag": "Y",
      "SyscPartnOmOnlyFlag": "N",
      "SyscHtmlEmailFlag": "N",
      "SyscIndepContractorFlag": "N",
      "SyscVUuid": "352176670B976210E0630B811DAC93A5",
      "SyscLastModifiedDate": "2025-05-14T22:57:11Z",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/352176670B976210E0630B811DAC93A5",
          "name": "syscontact",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/352176670B976210E0630B811DAC93A5",
          "name": "syscontact",
          "kind": "item"
        }
      ]
    },
    {
      "SyscContactCode": "LME",
      "SyscFirstName": "Leo1",
      "SyscMiddleName": null,
      "SyscLastName": "Messi",
      "SyscDisplayName": "Leo1 Messi",
      "SyscPrefixName": "Mr",
      "SyscSuffixName": null,
      "SyscAkaName": null,
      "SyscEmpNo": null,
      "SyscContactDesc": null,
      "SyscAddCompCode": "ZZ",
      "SyscAddCode": "A",
      "SyscAddLine1": "4850 Keele",
      "SyscAddLine2": null,
      "SyscAddLine3": null,
      "SyscRegionCode": null,
      "SyscPostalCode": null,
      "SyscCountry": "Canada",
      "SyscWorkPhoneNum": "123 312 2983",
      "SyscHomePhoneNum": null,
      "SyscMobileNum": null,
      "SyscPagerNum": null,
      "SyscFaxNum1": "234 312 2983",
      "SyscFaxNum2": null,
      "SyscEmail1": "leomessi@test.com",
      "SyscEmail1Link": "leomessi@test.com",
      "SyscEmail2": null,
      "SyscEmail2Link": null,
      "SyscWwwSite": null,
      "SyscPmRoleCode": "PROJMGR",
      "SyscPmRoleName": "PROJ. MANAGER",
      "SyscOther": null,
      "SyscPrefContactMth": "MAIL",
      "SyscActiveFlag": "Y",
      "SyscPartnCode": "ZZ",
      "SyscPartnTypeCode": "C",
      "SyscPartnName": "CMiC-ZZ  Test Company Incorp",
      "SyscPrimaryFlag": "N",
      "SyscLastUpdUser": "DAR",
      "SyscBidFlag": "N",
      "SyscCollabUsagePrice": null,
      "SyscCollabUserFlag": "N",
      "SyscPartnOmOnlyFlag": "N",
      "SyscHtmlEmailFlag": "N",
      "SyscIndepContractorFlag": "N",
      "SyscVUuid": "34F4F8D12E43277EE0630B811DAC0469",
      "SyscLastModifiedDate": "2025-05-12T19:59:19Z",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/34F4F8D12E43277EE0630B811DAC0469",
          "name": "syscontact",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/34F4F8D12E43277EE0630B811DAC0469",
          "name": "syscontact",
          "kind": "item"
        }
      ]
    },
    {
      "SyscContactCode": "LMES",
      "SyscFirstName": "Lio",
      "SyscMiddleName": null,
      "SyscLastName": "Messi",
      "SyscDisplayName": "Lio Messi",
      "SyscPrefixName": "Mr",
      "SyscSuffixName": null,
      "SyscAkaName": null,
      "SyscEmpNo": null,
      "SyscContactDesc": null,
      "SyscAddCompCode": "ZZ",
      "SyscAddCode": "A",
      "SyscAddLine1": "4850 Keele",
      "SyscAddLine2": null,
      "SyscAddLine3": null,
      "SyscRegionCode": null,
      "SyscPostalCode": null,
      "SyscCountry": "Canada",
      "SyscWorkPhoneNum": "123 312 2983",
      "SyscHomePhoneNum": null,
      "SyscMobileNum": null,
      "SyscPagerNum": null,
      "SyscFaxNum1": "234 312 2983",
      "SyscFaxNum2": null,
      "SyscEmail1": "leomessi@test.com",
      "SyscEmail1Link": "leomessi@test.com",
      "SyscEmail2": null,
      "SyscEmail2Link": null,
      "SyscWwwSite": null,
      "SyscPmRoleCode": "PROJMGR",
      "SyscPmRoleName": "PROJ. MANAGER",
      "SyscOther": null,
      "SyscPrefContactMth": "MAIL",
      "SyscActiveFlag": "Y",
      "SyscPartnCode": "ZZ",
      "SyscPartnTypeCode": "C",
      "SyscPartnName": "CMiC-ZZ  Test Company Incorp",
      "SyscPrimaryFlag": "N",
      "SyscLastUpdUser": "DAR",
      "SyscBidFlag": "N",
      "SyscCollabUsagePrice": null,
      "SyscCollabUserFlag": "N",
      "SyscPartnOmOnlyFlag": "N",
      "SyscHtmlEmailFlag": "N",
      "SyscIndepContractorFlag": "N",
      "SyscVUuid": "351F2B3AC39E76B9E0630B811DAC6D59",
      "SyscLastModifiedDate": "2025-05-14T20:12:32Z",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/351F2B3AC39E76B9E0630B811DAC6D59",
          "name": "syscontact",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/351F2B3AC39E76B9E0630B811DAC6D59",
          "name": "syscontact",
          "kind": "item"
        }
      ]
    },
    {
      "SyscContactCode": "RMAT",
      "SyscFirstName": "Rijoe",
      "SyscMiddleName": null,
      "SyscLastName": "Mathew",
      "SyscDisplayName": "Rijoe Mathew",
      "SyscPrefixName": null,
      "SyscSuffixName": null,
      "SyscAkaName": null,
      "SyscEmpNo": "RM123456",
      "SyscContactDesc": null,
      "SyscAddCompCode": null,
      "SyscAddCode": null,
      "SyscAddLine1": null,
      "SyscAddLine2": null,
      "SyscAddLine3": null,
      "SyscRegionCode": null,
      "SyscPostalCode": null,
      "SyscCountry": null,
      "SyscWorkPhoneNum": null,
      "SyscHomePhoneNum": null,
      "SyscMobileNum": null,
      "SyscPagerNum": null,
      "SyscFaxNum1": null,
      "SyscFaxNum2": null,
      "SyscEmail1": "rijoe.mathew@cmic.ca",
      "SyscEmail1Link": "rijoe.mathew@cmic.ca",
      "SyscEmail2": null,
      "SyscEmail2Link": null,
      "SyscWwwSite": null,
      "SyscPmRoleCode": "GM",
      "SyscPmRoleName": "General Manager",
      "SyscOther": null,
      "SyscPrefContactMth": "MAIL",
      "SyscActiveFlag": "Y",
      "SyscPartnCode": "ZZ",
      "SyscPartnTypeCode": "C",
      "SyscPartnName": "CMiC-ZZ  Test Company Incorp",
      "SyscPrimaryFlag": "N",
      "SyscLastUpdUser": "DAR",
      "SyscBidFlag": "N",
      "SyscCollabUsagePrice": null,
      "SyscCollabUserFlag": "Y",
      "SyscPartnOmOnlyFlag": "N",
      "SyscHtmlEmailFlag": "N",
      "SyscIndepContractorFlag": "N",
      "SyscVUuid": "04E0393CF12C5FDBE063AF811DACF482",
      "SyscLastModifiedDate": "2025-05-14T18:26:03Z",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/04E0393CF12C5FDBE063AF811DACF482",
          "name": "syscontact",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact/04E0393CF12C5FDBE063AF811DACF482",
          "name": "syscontact",
          "kind": "item"
        }
      ]
    }
  ],
  "totalResults": 5,
  "count": 5,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7101/sys-rest-api/rest/1/syscontact",
      "name": "syscontact",
      "kind": "collection"
    }
  ]
}
object