Users

The users endpoint is a GET only endpoint that is used to retrieve data about users within PCRecruiter.

This information is limited to basic contact information, as well as email setup information. This endpoint can be useful to sync any contact information for a user, with the information found in PCRecruiter.

Default data parameters

• UserName - This is the unique username for the user.
• FullName - This parameter is the full name for the user in the array.
• EmailAddress - EmailAddress is the email address registered for this user. This may vary from the email used for outgoing or incoming email within PCRecruiter for this user.
• Phone - The phone number listed for this username.
• Phone Ext - The phone extension listed for this username.
• ReplicationNumber: Prepended to record IDs to denote which user added the record (e.g., "R123-456789").
• ActiveUser: A boolean parameter that indicates whether the user is currently active in PCRecruiter. Non-active users cannot access PCRecruiter services or endpoints.

Teams (Groups)

The Teams field returns the list of groups (teams) that a user belongs to. This field is not included in the default response and must be explicitly requested using the Fields parameter.

Each team object includes:

• Name: The name of the team/group.
• RecordId: The unique identifier for the team/group.

Example: GET /rest/api/users?Fields=Teams

EmailAliases data parameters

The emailaliases section of the users endpoint is used to list the outgoing email setup options for each user. This is just basic information and does not include advanced setup information for each email alias. The email aliases that are returned will only be for the username that was used to create the session token used in the authorization of this call.

• Description: Helpful for distinguishing between multiple email aliases, such as "Sales Team Email" or "Primary Contact Email."
• Email: The address used for outgoing messages linked to the alias (e.g., "support@mainsequence.net").
• Name: The display name in the "From" field (e.g., "John Doe").

Examples

------------------ REQUEST -------------------

GET /rest/api/users

{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Users",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------

{  
"TotalRecords": 2,  
"Results":[  
{  
"UserName": "SAMPLE",  
"FullName": "John Doe",  
"EmailAddress": "support@mainsequence.net",  
"Phone": "(440) 946-5214",  
"PhoneExt": null,  
"ReplicationNumber": null,  
"ActiveUser": true  
},  
{  
"UserName": "APIUSER",  
"FullName": "APIUSER",  
"EmailAddress": null,  
"Phone": null,  
"PhoneExt": null,  
"ReplicationNumber": null,  
"ActiveUser": false  
}  
]  
}

TIP

This API call returns all usernames in the database with their contact information listed, as well as their active status in PCRecruiter.

------------------ REQUEST -------------------

GET /rest/api/users/{UserName}

{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Users/{UserName}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------

{  
"UserName": "SAMPLE",  
"FullName": "John Doe",  
"EmailAddress": "support@mainsequence.net",  
"Phone": "(440) 946-5214",  
"PhoneExt": null,  
"ReplicationNumber": null,  
"ActiveUser": true  
}

TIP

This API call returns all of the contact information for the username appended to the API call URL.

------------------ REQUEST -------------------

GET /rest/api/users?Fields=Teams

{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Users?Fields=Teams",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------

{  
"TotalRecords": 2,  
"Results":[  
{  
"UserName": "SAMPLE",  
"FullName": "John Doe",  
"EmailAddress": "support@mainsequence.net",  
"Phone": "(440) 946-5214",  
"PhoneExt": null,  
"ReplicationNumber": null,  
"ActiveUser": true,  
"Teams": [  
{  
"Name": "Sales Team",  
"RecordId": 12345  
},  
{  
"Name": "East Region",  
"RecordId": 67890  
}  
]  
},  
{  
"UserName": "APIUSER",  
"FullName": "APIUSER",  
"EmailAddress": null,  
"Phone": null,  
"PhoneExt": null,  
"ReplicationNumber": null,  
"ActiveUser": false,  
"Teams": []  
}  
]  
}

TIP

This API call returns all usernames with their team/group memberships included by using the Fields=Teams parameter.

------------------ REQUEST -------------------

GET /rest/api/users/EmailAliases

{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Users/EmailAliases",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------

{  
"Results":[  
{  
"description": "Primary Email",  
"email": "support@mainsequence.net",  
"name": "John Doe"  
},  
{  
"description": "Secondary Email",  
"email": "lms@mainsequence.net",  
"name": "John Doe"  
}  
]  
}

TIP

This API call returns all of the outgoing email setup information for the username that was used to create the session token used in the authorization of the API call.