With our community of partners, you can get expert advice and training so you can be up and running in no time! SETUP PARTNERS

API Documentation 

Staff Methods

Method Description
GET list Return a list of all staff members
GET get/[uuid] Details for a specific staff member
POST add Add a staff member
PUT update Update a staff members details
POST delete Delete a staff member
POST enable Enable a staff member so they can log into WorkflowMax
POST disable Disable a staff member so they can no longer log into WorkflowMax
POST forgottenpassword Reset a staff members password. The staff member will be sent an email to reset their password. This is the same as the staff member using the Forgotten Password process.

GET list

Return a list of all staff members

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/list

Example Response

<Response>
  <Status>OK</Status> 
  <StaffList>
    <Staff>
      <UUID>47158cb8-20e7-4b42-801a-ca7927e1a2b7</UUID>
      <Name>Jo Bloggs</Name> 
      <Email>jo@bloggs.net</Email> 
      <Phone /> 
      <Mobile /> 
      <Address /> 
      <PayrollCode />
    </Staff>
    <Staff>
      <UUID>6023a4c0-0953-479b-bd08-144b0e9d9250</UUID>
      <Name>John Smith</Name> 
      <Email>john@smith.com</Email> 
      <Phone /> 
      <Mobile /> 
      <Address />
      <PayrollCode /> 
    </Staff>
  </StaffList>
</Response>

GET get/[uuid]

Details for a specific staff member

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/get/47158cb8-20e7-4b42-801a-ca7927e1a2b7

Example Response

<Response>
  <Status>OK</Status> 
  <Staff>
    <UUID>47158cb8-20e7-4b42-801a-ca7927e1a2b7</UUID>
    <Name>Jo Bloggs</Name> 
    <Email>jo@bloggs.net</Email> 
    <Phone /> 
    <Mobile /> 
    <Address /> 
    <PayrollCode /> 
  </Staff>
</Response>

POST add

Add a staff member

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/add

Example Message

<Staff>
  <Name>John Smith</Name>
  <Address></Address>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Mobile></Mobile>  <!-- optional -->   
  <Email></Email>  <!-- optional -->   
  <PayrollCode></PayrollCode>  <!-- optional -->   
</Staff>

The response will include the detailed information of the staff member as per the GET get/[identifier] method

PUT update

Update a staff members details

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/update

Example Message

<Staff>
  <UUID>4db95077-ffbb-4393-91b0-4d051bae4365</UUID>
  <Name>John Smith</Name>
  <Address></Address>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Mobile></Mobile>  <!-- optional -->   
  <Email></Email>  <!-- optional -->   
  <PayrollCode></PayrollCode>  <!-- optional -->   
</Staff>

The response will include the detailed information of the staff member as per the GET get/[identifier] method

POST delete

Delete a staff member

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/delete

Example Message

<Staff>
  <UUID>4db95077-ffbb-4393-91b0-4d051bae4365</UUID>
</Staff>

POST enable

Enable a staff member so they can log into WorkflowMax

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/enable

Example Message

<Staff>
  <UUID>4db95077-ffbb-4393-91b0-4d051bae4365</UUID>
  <Security> 
  </Security>
</Staff>

POST disable

Disable a staff member so they can no longer log into WorkflowMax

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/disable

Example Message

<Staff>
  <UUID>4db95077-ffbb-4393-91b0-4d051bae4365</UUID>
</Staff>

POST forgottenpassword

Reset a staff members password. The staff member will be sent an email to reset their password. This is the same as the staff member using the Forgotten Password process.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/staff.api/forgottenpassword

Example Message

<Staff>
  <UUID>4db95077-ffbb-4393-91b0-4d051bae4365</UUID>
</Staff>