GET v1/admin/company/{id}/directory?sort={sort}

Retrieves the Persons associated with the company in question

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

sort

A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of GetCompanyDirectoryOutput
NameDescriptionTypeAdditional information
id

integer

None.

FirstLast

string

None.

Email

string

None.

MemberType

string

None.

JoinDate

date

None.

DuesPaidThru

date

None.

StatusName

string

None.

Title

string

None.

PreferredPhone

string

None.

preferredPhoneNumber

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "FirstLast": "sample string 2",
    "Email": "sample string 3",
    "MemberType": "sample string 4",
    "JoinDate": "2024-09-27T11:24:32.4082108+00:00",
    "DuesPaidThru": "2024-09-27T11:24:32.4082108+00:00",
    "StatusName": "sample string 7",
    "Title": "sample string 8",
    "PreferredPhone": "sample string 9",
    "preferredPhoneNumber": "sample string 10"
  },
  {
    "id": 1,
    "FirstLast": "sample string 2",
    "Email": "sample string 3",
    "MemberType": "sample string 4",
    "JoinDate": "2024-09-27T11:24:32.4082108+00:00",
    "DuesPaidThru": "2024-09-27T11:24:32.4082108+00:00",
    "StatusName": "sample string 7",
    "Title": "sample string 8",
    "PreferredPhone": "sample string 9",
    "preferredPhoneNumber": "sample string 10"
  }
]

text/html

Sample:
[{"id":1,"FirstLast":"sample string 2","Email":"sample string 3","MemberType":"sample string 4","JoinDate":"2024-09-27T11:24:32.4082108+00:00","DuesPaidThru":"2024-09-27T11:24:32.4082108+00:00","StatusName":"sample string 7","Title":"sample string 8","PreferredPhone":"sample string 9","preferredPhoneNumber":"sample string 10"},{"id":1,"FirstLast":"sample string 2","Email":"sample string 3","MemberType":"sample string 4","JoinDate":"2024-09-27T11:24:32.4082108+00:00","DuesPaidThru":"2024-09-27T11:24:32.4082108+00:00","StatusName":"sample string 7","Title":"sample string 8","PreferredPhone":"sample string 9","preferredPhoneNumber":"sample string 10"}]

application/xml, text/xml

Sample:
<ArrayOfv1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <v1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput>
    <DuesPaidThru>2024-09-27T11:24:32.4082108+00:00</DuesPaidThru>
    <Email>sample string 3</Email>
    <FirstLast>sample string 2</FirstLast>
    <JoinDate>2024-09-27T11:24:32.4082108+00:00</JoinDate>
    <MemberType>sample string 4</MemberType>
    <PreferredPhone>sample string 9</PreferredPhone>
    <StatusName>sample string 7</StatusName>
    <Title>sample string 8</Title>
    <id>1</id>
    <preferredPhoneNumber>sample string 10</preferredPhoneNumber>
  </v1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput>
  <v1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput>
    <DuesPaidThru>2024-09-27T11:24:32.4082108+00:00</DuesPaidThru>
    <Email>sample string 3</Email>
    <FirstLast>sample string 2</FirstLast>
    <JoinDate>2024-09-27T11:24:32.4082108+00:00</JoinDate>
    <MemberType>sample string 4</MemberType>
    <PreferredPhone>sample string 9</PreferredPhone>
    <StatusName>sample string 7</StatusName>
    <Title>sample string 8</Title>
    <id>1</id>
    <preferredPhoneNumber>sample string 10</preferredPhoneNumber>
  </v1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput>
</ArrayOfv1_Admin_CompanyEndpointController.GetCompanyDirectoryOutput>