GET v1/Clients/{clientId}/Contacts?unassociatedOnly={unassociatedOnly}&facilityId={facilityId}&contactTypeReferenceId={contactTypeReferenceId}

Gets a list of contacts matching the provided parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client identifier.

 globally unique identifier

Required
unassociatedOnly

Unassociated Only Filter. (optional) When true, will return only Contacts with no Facility Associations, otherwise will return all matching contacts.

 boolean

Default value is False
facilityId

The facility identifier.

 integer

None.
contactTypeReferenceId

The Contact Type Reference Id. Valid values can be retrieved from v2/Clients/{clientId}/References?type=ContactType.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

A list of .

Collection of ContactV1
NameDescriptionTypeAdditional information
Id

The contact identifier.

 integer

None.
FacilityId

The Facility Identifier. (optional) When NOT NULL, the Contact will only be associated to the specified Facility. When NULL, the Contact can be associated to any number of Facilities by using the POST v1/Clients/{clientId}/Contacts/{contactId}/FacilityAssociations endpoint.

 integer

None.
ContactTypeReferenceId

The Contact Type Reference Id. Valid values can be retrieved from v1/Clients/{clientId}/References?type=ContactType.

 integer

None.
ExternalId

This value is an identifier used outside of the Titan system that can be used to identify the contact via another system. Not required.

 string

None.
PrefixName

The contact's prefix (i.e. Mr., Mrs., Ms., Dr., etc).

 string

None.
FirstName

The contact's first name. Required if Organization Name is not set.

 string

None.
LastName

The contact's last name. Required if Organization Name is not set.

 string

None.
SuffixName

The contact's suffix (i.e. Jr., Sr., III, etc).

 string

None.
DisplayOnFacilityProfile

A flag that indicates whether the contact will display on a facility's profile page if the contact is associated to that facility.

 boolean

None.
OrganizationName

The contact organization name. Required if first and last name are not set.

 string

None.
Department

The department for the contact.

 string

None.
JobTitle

The contact's job title.

 string

None.
PrimaryEmailAddress

The contact's primary email address. You may comma-separate up to 45 email addresses for this value.

 string

None.
SecondaryEmailAddress

The contact's secondary email address. You may comma-separate up to 45 email addresses for this value.

 string

None.
PrimaryPhoneNumber

The contact's primary phone number.

 string

None.
SecondaryPhoneNumber

The contact's secondary phone number.

 string

None.
PrimaryAddress

The contact's primary address.

 string

None.
SecondaryAddress

The contact's secondary address.

 string

None.
AssociationRule

The contact's DynamicAssociationRule.

 DynamicAssociationRuleV1

None.
ManuallyAssociatedFacilities

A list of Facility Identifiers. The Contact will be associated with each Facility specified, regardless of the AssociationRule.

 Collection of integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "FacilityId": 1,
    "ContactTypeReferenceId": 1,
    "ExternalId": "sample string 2",
    "PrefixName": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "SuffixName": "sample string 6",
    "DisplayOnFacilityProfile": true,
    "OrganizationName": "sample string 8",
    "Department": "sample string 9",
    "JobTitle": "sample string 10",
    "PrimaryEmailAddress": "sample string 11",
    "SecondaryEmailAddress": "sample string 12",
    "PrimaryPhoneNumber": "sample string 13",
    "SecondaryPhoneNumber": "sample string 14",
    "PrimaryAddress": "sample string 15",
    "SecondaryAddress": "sample string 16",
    "AssociationRule": {
      "AssociatedStateProvinceCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "AssociatedFacilityGroups": [
        1,
        2
      ],
      "AssociatedFacilityStatuses": [
        1,
        2
      ],
      "FacilityMustMatchAllCriteria": true
    },
    "ManuallyAssociatedFacilities": [
      1,
      2
    ]
  },
  {
    "Id": 1,
    "FacilityId": 1,
    "ContactTypeReferenceId": 1,
    "ExternalId": "sample string 2",
    "PrefixName": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "SuffixName": "sample string 6",
    "DisplayOnFacilityProfile": true,
    "OrganizationName": "sample string 8",
    "Department": "sample string 9",
    "JobTitle": "sample string 10",
    "PrimaryEmailAddress": "sample string 11",
    "SecondaryEmailAddress": "sample string 12",
    "PrimaryPhoneNumber": "sample string 13",
    "SecondaryPhoneNumber": "sample string 14",
    "PrimaryAddress": "sample string 15",
    "SecondaryAddress": "sample string 16",
    "AssociationRule": {
      "AssociatedStateProvinceCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "AssociatedFacilityGroups": [
        1,
        2
      ],
      "AssociatedFacilityStatuses": [
        1,
        2
      ],
      "FacilityMustMatchAllCriteria": true
    },
    "ManuallyAssociatedFacilities": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
  <Contact>
    <AssociationRule xmlns:d3p1="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.Contacts">
      <d3p1:AssociatedFacilityGroups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:AssociatedFacilityGroups>
      <d3p1:AssociatedFacilityStatuses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:AssociatedFacilityStatuses>
      <d3p1:AssociatedStateProvinceCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d3p1:AssociatedStateProvinceCodes>
      <d3p1:FacilityMustMatchAllCriteria>true</d3p1:FacilityMustMatchAllCriteria>
    </AssociationRule>
    <ContactTypeReferenceId>1</ContactTypeReferenceId>
    <Department>sample string 9</Department>
    <DisplayOnFacilityProfile>true</DisplayOnFacilityProfile>
    <ExternalId>sample string 2</ExternalId>
    <FacilityId>1</FacilityId>
    <FirstName>sample string 4</FirstName>
    <Id>1</Id>
    <JobTitle>sample string 10</JobTitle>
    <LastName>sample string 5</LastName>
    <ManuallyAssociatedFacilities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ManuallyAssociatedFacilities>
    <OrganizationName>sample string 8</OrganizationName>
    <PrefixName>sample string 3</PrefixName>
    <PrimaryAddress>sample string 15</PrimaryAddress>
    <PrimaryEmailAddress>sample string 11</PrimaryEmailAddress>
    <PrimaryPhoneNumber>sample string 13</PrimaryPhoneNumber>
    <SecondaryAddress>sample string 16</SecondaryAddress>
    <SecondaryEmailAddress>sample string 12</SecondaryEmailAddress>
    <SecondaryPhoneNumber>sample string 14</SecondaryPhoneNumber>
    <SuffixName>sample string 6</SuffixName>
  </Contact>
  <Contact>
    <AssociationRule xmlns:d3p1="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.Contacts">
      <d3p1:AssociatedFacilityGroups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:AssociatedFacilityGroups>
      <d3p1:AssociatedFacilityStatuses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:AssociatedFacilityStatuses>
      <d3p1:AssociatedStateProvinceCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d3p1:AssociatedStateProvinceCodes>
      <d3p1:FacilityMustMatchAllCriteria>true</d3p1:FacilityMustMatchAllCriteria>
    </AssociationRule>
    <ContactTypeReferenceId>1</ContactTypeReferenceId>
    <Department>sample string 9</Department>
    <DisplayOnFacilityProfile>true</DisplayOnFacilityProfile>
    <ExternalId>sample string 2</ExternalId>
    <FacilityId>1</FacilityId>
    <FirstName>sample string 4</FirstName>
    <Id>1</Id>
    <JobTitle>sample string 10</JobTitle>
    <LastName>sample string 5</LastName>
    <ManuallyAssociatedFacilities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ManuallyAssociatedFacilities>
    <OrganizationName>sample string 8</OrganizationName>
    <PrefixName>sample string 3</PrefixName>
    <PrimaryAddress>sample string 15</PrimaryAddress>
    <PrimaryEmailAddress>sample string 11</PrimaryEmailAddress>
    <PrimaryPhoneNumber>sample string 13</PrimaryPhoneNumber>
    <SecondaryAddress>sample string 16</SecondaryAddress>
    <SecondaryEmailAddress>sample string 12</SecondaryEmailAddress>
    <SecondaryPhoneNumber>sample string 14</SecondaryPhoneNumber>
    <SuffixName>sample string 6</SuffixName>
  </Contact>
</ArrayOfContact>