Staff

A Staff is a person handling Helpdesk duties like responding to incoming tickets, solving the requests / problems covered in the tickets.

Read All Staff

Retrieve a list of all staff.

URL <base_uri> / <response_format> /staff/
HTTP Method GET
Response Data List of staff

Data Structure

JSON

                    
    [
        {
            "name": "Scott ", 
            "email": "scott@example.com", 
            "role": {
                "name": "Administrator", 
                "id": 1
            }, 
            "active": true, 
            "id": 2, 
            "categories": [
                1, 
                2, 
                4, 
                5
            ], 
            "permissions": [
                "manage_staff", 
                "manage_contacts", 
                "manage_templates", 
                "manage_kb", 
                "manage_smart_rules", 
                "email_reply", 
                "web_reply", 
                "edit_replies", 
                "delete_replies", 
                "delete_tickets", 
                "close_tickets", 
                "move_tickets", 
                "split_tickets", 
                "assign_tickets", 
                "set_due_date", 
                "manage_categories", 
                "manage_priorities", 
                "manage_statuses", 
                "manage_ticket_custom", 
                "manage_client_custom", 
                "manage_integrations", 
                "manage_canned_actions", 
                "all_tickets", 
                "relate_tickets", 
                "manage_sla", 
                "reassign_tickets", 
                "act_on_closed", 
                "change_ticket_contact", 
                "create_ticket_in_any_category", 
                "move_ticket_to_any_category", 
                "create_edit_reports", 
                "export_reports", 
                "forward_tickets", 
                "manage_contact_groups", 
                "edit_subject", 
                "view_reports"
            ]
        }, 
        {
            "name": "James ", 
            "email": "james@example.com", 
            "role": {
                "name": "Administrator", 
                "id": 1
            }, 
            "active": true, 
            "id": 3, 
            "categories": [
                1, 
                2, 
                4, 
                5
            ], 
            "permissions": [
                "manage_staff", 
                "manage_contacts", 
                "manage_templates", 
                "manage_kb", 
                "manage_smart_rules", 
                "email_reply", 
                "web_reply", 
                "edit_replies", 
                "delete_replies", 
                "delete_tickets", 
                "close_tickets", 
                "move_tickets", 
                "split_tickets", 
                "assign_tickets", 
                "set_due_date", 
                "manage_categories", 
                "manage_priorities", 
                "manage_statuses", 
                "manage_ticket_custom", 
                "manage_client_custom", 
                "manage_integrations", 
                "manage_canned_actions", 
                "all_tickets", 
                "relate_tickets", 
                "manage_sla", 
                "reassign_tickets", 
                "act_on_closed", 
                "change_ticket_contact", 
                "create_ticket_in_any_category", 
                "move_ticket_to_any_category", 
                "create_edit_reports", 
                "export_reports", 
                "forward_tickets", 
                "manage_contact_groups", 
                "edit_subject", 
                "view_reports"
            ]
        }, 
        {
            "name": "Adam Smith", 
            "email": "adam.smith@example.com", 
            "role": {
                "name": "Administrator", 
                "id": 1
            }, 
            "active": true, 
            "id": 1, 
            "categories": [
                1, 
                2, 
                4, 
                5
            ], 
            "permissions": [
                "manage_staff", 
                "manage_contacts", 
                "manage_templates", 
                "manage_kb", 
                "manage_smart_rules", 
                "email_reply", 
                "web_reply", 
                "edit_replies", 
                "delete_replies", 
                "delete_tickets", 
                "close_tickets", 
                "move_tickets", 
                "split_tickets", 
                "assign_tickets", 
                "set_due_date", 
                "manage_categories", 
                "manage_priorities", 
                "manage_statuses", 
                "manage_ticket_custom", 
                "manage_client_custom", 
                "manage_integrations", 
                "manage_canned_actions", 
                "all_tickets", 
                "relate_tickets", 
                "manage_sla", 
                "reassign_tickets", 
                "act_on_closed", 
                "change_ticket_contact", 
                "create_ticket_in_any_category", 
                "move_ticket_to_any_category", 
                "create_edit_reports", 
                "export_reports", 
                "forward_tickets", 
                "manage_contact_groups", 
                "edit_subject", 
                "view_reports"
            ]
        }
    ]
                    
                

Read One Staff By ID

Retrieve details of a staff using their ID.

URL <base_uri> / <response_format> /staff/<id>/
HTTP Method GET
Response Data Staff

Data Structure

JSON

                    
    [
        {
            "name": "Adam Smith", 
            "email": "adam.smith@example.com", 
            "role": {
                "name": "Administrator", 
                "id": 1
            }, 
            "active": true, 
            "id": 1, 
            "categories": [
                1, 
                2, 
                4, 
                5
            ], 
            "permissions": [
                "manage_staff", 
                "manage_contacts", 
                "manage_templates", 
                "manage_kb", 
                "manage_smart_rules", 
                "email_reply", 
                "web_reply", 
                "edit_replies", 
                "delete_replies", 
                "delete_tickets", 
                "close_tickets", 
                "move_tickets", 
                "split_tickets", 
                "assign_tickets", 
                "set_due_date", 
                "manage_categories", 
                "manage_priorities", 
                "manage_statuses", 
                "manage_ticket_custom", 
                "manage_client_custom", 
                "manage_integrations", 
                "manage_canned_actions", 
                "all_tickets", 
                "relate_tickets", 
                "manage_sla", 
                "reassign_tickets", 
                "act_on_closed", 
                "change_ticket_contact", 
                "create_ticket_in_any_category", 
                "move_ticket_to_any_category", 
                "create_edit_reports", 
                "export_reports", 
                "forward_tickets", 
                "manage_contact_groups", 
                "edit_subject", 
                "view_reports"
            ]
        }
    ]
                    
                

Read One Staff By Email

Retrieve details of a staff using their email address.

URL <base_uri> / <response_format> /staff/<email>/
HTTP Method GET
Response Data Staff

Data Structure

JSON

                    
    [
        {
            "name": "Adam Smith", 
            "email": "adam.smith@example.com", 
            "role": {
                "name": "Administrator", 
                "id": 1
            }, 
            "active": true, 
            "id": 1, 
            "categories": [
                1, 
                2, 
                4, 
                5
            ], 
            "permissions": [
                "manage_staff", 
                "manage_contacts", 
                "manage_templates", 
                "manage_kb", 
                "manage_smart_rules", 
                "email_reply", 
                "web_reply", 
                "edit_replies", 
                "delete_replies", 
                "delete_tickets", 
                "close_tickets", 
                "move_tickets", 
                "split_tickets", 
                "assign_tickets", 
                "set_due_date", 
                "manage_categories", 
                "manage_priorities", 
                "manage_statuses", 
                "manage_ticket_custom", 
                "manage_client_custom", 
                "manage_integrations", 
                "manage_canned_actions", 
                "all_tickets", 
                "relate_tickets", 
                "manage_sla", 
                "reassign_tickets", 
                "act_on_closed", 
                "change_ticket_contact", 
                "create_ticket_in_any_category", 
                "move_ticket_to_any_category", 
                "create_edit_reports", 
                "export_reports", 
                "forward_tickets", 
                "manage_contact_groups", 
                "edit_subject", 
                "view_reports"
            ]
        }
    ]