Back

GET sites/{siteId}/individuals?deleted={deleted}&tz={tz}

Read all individuals for your site.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
siteId globally unique identifier Required

Guid ID of the site.
deleted byte

Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.
tz string

Optional parameter to set time zone information.

Body Parameters

None.

Response Information

Resource Description (Individual)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given individual.
SiteID globally unique identifier ReadOnly

ID of the site for the given individual.
IsAdmin boolean

Administrator setting for the given individual.
UserID globally unique identifier ReadOnly

User ID of the given individual.
Prefix string

Prefix of the given individual's name. (Max length 25 characters)
Suffix string

Suffix of the given individual's name. (Max length 25 characters)
FirstName string Required

First name of the given individual. (Max length 50 characters)
LastName string Required

Last name of the given individual. (Max length 50 characters)
UserDefined1 string

User defined field one. (Max length 255 characters)
UserDefined2 string

User defined field two. (Max length 255 characters)
UserDefined3 string

User defined field three. (Max length 255 characters)
UserDefined4 string

User defined field four. (Max length 255 characters)
Email string Required on Create

Email address of the given individual. (Max length 255 characters)
PrimaryOrganizationID globally unique identifier Required on Create

ID of the primary organization of the given individual.
PrimaryTitle string Required on Create

Title of the given individual. (Max length 255 characters)
PrimaryReportsTo globally unique identifier Required on Create

ID of the primary reports to person for the given individual.
UserName string Required

User name of the given individual. (Max length 255 characters)
Password string

Password of the given individual(Used for create and update). (This varible has been Deprecated and may be removed at a later date.)
ParentID globally unique identifier Required on Create

Deprecated, this is no longer used and is always null.
PrimaryOrganizationName string ReadOnly

Name of the primary organization for the given individual.
FullName string ReadOnly

Full name of the given individual.
FormalName string ReadOnly

Formal name of the given individual.
FullOrderedName string ReadOnly

Full ordered name of the given individual.
Deleted boolean ReadOnly

Deleted status of the given individual.
DeletedByRef boolean ReadOnly

Deleted by reference status of the given individual.
Created date ReadOnly

Date the given individual was created.
CreatedBy globally unique identifier ReadOnly

ID of the person that created the given individual.
Updated date ReadOnly

Date the given individual was last updated.
UpdatedBy globally unique identifier ReadOnly

ID of the person that last updated the given individual.
IsGlobalAdmin boolean ReadOnly

Global administrator setting for the given individual.
UserEmail string Required on Create

User email address of the given individual. (This varible has been Deprecated and may be removed at a later date.)
LastComment string ReadOnly

Body of the most recent comment for the given individual.
LastCommentDate date ReadOnly

Date of the most recent comment for the given individual.
LastCommentByID globally unique identifier ReadOnly

ID of the individual who created the most recent comment for the given individual.
LastCommentBy string ReadOnly

Name of the individual who created the most recent comment for the given individual.
CanRead boolean ReadOnly

Read security setting for the individual based on the current logged in user.
CanUpdate boolean ReadOnly

Update security setting for the individual based on the current logged in user.
CanDelete boolean ReadOnly

Delete security setting for the individual based on the current logged in user.
CanDelegate boolean ReadOnly

Delegate security setting for the individual based on the current logged in user.
SendEvalSurvey boolean ReadOnly

Send Individual Evaluation Surveys
HireDate date

Date the given Individual was hired.

Response Formats

application/xml, text/xml

Sample
<Individual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>447793ae-c1ca-479e-a679-ddec3aa1eeb3</ID>
  <SiteID>e6cf9b5a-fa82-46dc-96ae-436eda24743e</SiteID>
  <IsAdmin>true</IsAdmin>
  <UserID>5e7d1167-66eb-49be-889e-53da955e1c68</UserID>
  <Prefix>sample string 1</Prefix>
  <Suffix>sample string 2</Suffix>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <UserDefined1>sample string 5</UserDefined1>
  <UserDefined2>sample string 6</UserDefined2>
  <UserDefined3>sample string 7</UserDefined3>
  <UserDefined4>sample string 8</UserDefined4>
  <Email>sample string 9</Email>
  <PrimaryOrganizationID>3f24faa7-cd98-4bab-b582-f77e8b63a463</PrimaryOrganizationID>
  <PrimaryTitle>sample string 10</PrimaryTitle>
  <PrimaryReportsTo>89d9873f-b2d7-4cbd-8f2c-dadaf631f9ed</PrimaryReportsTo>
  <UserName>sample string 11</UserName>
  <Password>sample string 12</Password>
  <ParentID>023bb207-be9f-4eb1-8838-4828428cfb84</ParentID>
  <PrimaryOrganizationName>sample string 13</PrimaryOrganizationName>
  <FullName>sample string 14</FullName>
  <FormalName>sample string 15</FormalName>
  <FullOrderedName>sample string 16</FullOrderedName>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2024-10-24T11:49:27.2213017+00:00</Created>
  <CreatedBy>20a82639-3613-4b41-9e69-acffd3342c4f</CreatedBy>
  <Updated>2024-10-24T11:49:27.2213017+00:00</Updated>
  <UpdatedBy>6da17e51-6ffe-470a-9a50-3f923c54a0e4</UpdatedBy>
  <IsGlobalAdmin>true</IsGlobalAdmin>
  <UserEmail>sample string 19</UserEmail>
  <LastComment>sample string 20</LastComment>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T11:49:27.2213017Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>6951b5d1-64b9-4586-b366-e893bebe6c47</LastCommentByID>
  <LastCommentBy>sample string 21</LastCommentBy>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
  <SendEvalSurvey>true</SendEvalSurvey>
  <HireDate>2024-10-24T11:49:27.2213017+00:00</HireDate>
</Individual>

application/json, text/json

Sample
{
  "ID": "447793ae-c1ca-479e-a679-ddec3aa1eeb3",
  "SiteID": "e6cf9b5a-fa82-46dc-96ae-436eda24743e",
  "IsAdmin": true,
  "UserID": "5e7d1167-66eb-49be-889e-53da955e1c68",
  "Prefix": "sample string 1",
  "Suffix": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "UserDefined1": "sample string 5",
  "UserDefined2": "sample string 6",
  "UserDefined3": "sample string 7",
  "UserDefined4": "sample string 8",
  "Email": "sample string 9",
  "PrimaryOrganizationID": "3f24faa7-cd98-4bab-b582-f77e8b63a463",
  "PrimaryTitle": "sample string 10",
  "PrimaryReportsTo": "89d9873f-b2d7-4cbd-8f2c-dadaf631f9ed",
  "UserName": "sample string 11",
  "Password": "sample string 12",
  "ParentID": "023bb207-be9f-4eb1-8838-4828428cfb84",
  "PrimaryOrganizationName": "sample string 13",
  "FullName": "sample string 14",
  "FormalName": "sample string 15",
  "FullOrderedName": "sample string 16",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2024-10-24T11:49:27.2213017+00:00",
  "CreatedBy": "20a82639-3613-4b41-9e69-acffd3342c4f",
  "Updated": "2024-10-24T11:49:27.2213017+00:00",
  "UpdatedBy": "6da17e51-6ffe-470a-9a50-3f923c54a0e4",
  "IsGlobalAdmin": true,
  "UserEmail": "sample string 19",
  "LastComment": "sample string 20",
  "LastCommentDate": "2024-10-24T11:49:27.2213017+00:00",
  "LastCommentByID": "6951b5d1-64b9-4586-b366-e893bebe6c47",
  "LastCommentBy": "sample string 21",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "SendEvalSurvey": true,
  "HireDate": "2024-10-24T11:49:27.2213017+00:00"
}