GET groups/{groupId}/contacts/{searchString}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

integer

Required

searchString

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Contact
NameDescriptionTypeAdditional information
ContactId

integer

None.

UserId

integer

None.

OrganizationId

integer

None.

CreatedDate

date

None.

Firstname

string

None.

Lastname

string

None.

PhoneNumber

string

None.

Email

string

None.

Description

string

None.

Description2

string

None.

Description3

string

None.

CPAAccepted

boolean

None.

IsPrivate

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContactId": 1,
    "UserId": 2,
    "OrganizationId": 3,
    "CreatedDate": "2024-03-29T08:11:52.313+01:00",
    "Firstname": "sample string 5",
    "Lastname": "sample string 6",
    "PhoneNumber": "sample string 7",
    "Email": "sample string 8",
    "Description": "sample string 9",
    "Description2": "sample string 10",
    "Description3": "sample string 11",
    "CPAAccepted": true,
    "IsPrivate": true
  },
  {
    "ContactId": 1,
    "UserId": 2,
    "OrganizationId": 3,
    "CreatedDate": "2024-03-29T08:11:52.313+01:00",
    "Firstname": "sample string 5",
    "Lastname": "sample string 6",
    "PhoneNumber": "sample string 7",
    "Email": "sample string 8",
    "Description": "sample string 9",
    "Description2": "sample string 10",
    "Description3": "sample string 11",
    "CPAAccepted": true,
    "IsPrivate": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfContact xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Contact>
    <Firstname>sample string 5</Firstname>
    <Lastname>sample string 6</Lastname>
    <PhoneNumber>sample string 7</PhoneNumber>
    <Email>sample string 8</Email>
    <Description>sample string 9</Description>
    <Description2>sample string 10</Description2>
    <Description3>sample string 11</Description3>
    <CPAAccepted>true</CPAAccepted>
    <IsPrivate>true</IsPrivate>
    <ContactId>1</ContactId>
    <UserId>2</UserId>
    <OrganizationId>3</OrganizationId>
    <CreatedDate>2024-03-29T08:11:52.3132661+01:00</CreatedDate>
  </Contact>
  <Contact>
    <Firstname>sample string 5</Firstname>
    <Lastname>sample string 6</Lastname>
    <PhoneNumber>sample string 7</PhoneNumber>
    <Email>sample string 8</Email>
    <Description>sample string 9</Description>
    <Description2>sample string 10</Description2>
    <Description3>sample string 11</Description3>
    <CPAAccepted>true</CPAAccepted>
    <IsPrivate>true</IsPrivate>
    <ContactId>1</ContactId>
    <UserId>2</UserId>
    <OrganizationId>3</OrganizationId>
    <CreatedDate>2024-03-29T08:11:52.3132661+01:00</CreatedDate>
  </Contact>
</ArrayOfContact>