PerfexCRMInstall

Summary

Retrieve detailed information about a specific staff member by their Staff ID, with optional inclusion of their departments and permissions.

Inputs

• Staff ID (required) — The ID of the staff member to retrieve.
• Options — Optional parameters to include additional details about the staff member.
• Include Departments — Boolean flag to include the staff member's associated departments in the response.
• Include Permissions — Boolean flag to include the staff member's permissions in the response.

Output shape

a single record containing the staff member's detailed information

The output includes the staff member's basic data by default. If 'Include Departments' or 'Include Permissions' options are enabled, related departments and permissions data are included respectively. Errors will be returned as error objects if the staff member is not found or the API call fails.

Examples

Example 1: Get staff details without extra info

Provide the Staff ID with default options set to false to get basic staff details.

Example 2: Get staff with departments and permissions

Provide the Staff ID and set 'Include Departments' and/or 'Include Permissions' to true to retrieve related departments and permissions as part of the response.