API Documentation

Client Group Methods

Method	Description
GET list	Return a list of all client groups
GET get/[uuid]	Detailed information for a specific client group
POST add	Add a client group
PUT members	Manage the members of a client group
POST delete	Delete a client group

GET list

Return a list of all client groups

EXAMPLE URL

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

Example Response

<Response>
  <Status>OK</Status> 
  <Groups>
    <Group>
      <UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
      <Name>Bloggs Family</Name> 
      <Taxable>Yes</Taxable> <!-- Returned if the Practice Management module is enabled -->
    </Group>
    <Group>
      <UUID>892049ff-74d9-4aec-9a8a-e6412e997e4b</UUID>
      <Name>Smith Family</Name> 
      <Taxable>No</Taxable> <!-- Returned if the Practice Management module is enabled -->
    </Group>
  </Groups>
</Response>

GET get/[uuid]

Detailed information for a specific client group

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/clientgroup.api/get/e873137a-7e07-49a0-8987-130e7418ad34

Example Response

<Response>
  <Status>OK</Status> 
  <Group>
    <UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
    <Name>Bloggs Family</Name> 
    <Taxable>Yes</Taxable> <!-- Returned if the Practice Management module is enabled -->
    <Clients>
      <Client>
        <UUID>90208797-a4d6-48f3-9b77-c585aeb0473c</UUID> 
        <Name>Jo Bloggs</Name> 
      </Client>
      <Client>
        <UUID>eaa6b85b-5555-4934-aa5e-63dd285b9360</UUID>
        <Name>Bloggs Widget Ltd</Name> 
      </Client>
    <Clients>
  </Group>
</Response>

POST add

Add a client group

EXAMPLE URL

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

Example Message

<Group>
  <Name>Smith Group</Name>  <!-- Name of Group-->
  <Taxable>No</Name>  <!-- Optional taxable group setting for Practice Manager users-->
  <ClientUUID>12345678-5555-4934-aa5e-63dd285b9360</ClientUUID>  <!-- Client to add to group -->
</Group>

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

PUT members

Manage the members of a client group

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/clientgroup.api/members

Example Message

<Group>
  <UUID>c55793da-1cfd-4baf-86b3-89a246565721</UUID>  <!-- UUID of Group to add client to-->

  <add uuid="9b23fbf5-aea0-467d-b2e8-a80be2e73237" />  <!-- UUID of client to add to group -->
  <remove uuid="8af0464b-bc6c-4b0f-81f6-39df43286ec7" />  <!-- UUID of client to remove from group -->
</Group>

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

POST delete

Delete a client group

EXAMPLE URL

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

Example Message

<Group>
  <UUID>c55793da-1cfd-4baf-86b3-89a246565721</UUID>
</Group>