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

Client Group Methods

GET list Return a list of all client groups
GET get/[id] 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
EXAMPLE URL
https://api.workflowmax.com/clientgroup.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]&page=1
Example Response
<Response>
  <Status>OK</Status> 
  <Groups>
    <Group>
      <ID>123</ID> 
      <Name>Bloggs Family</Name> 
      <Taxable>Yes</Taxable> 
    </Group>
    <Group>
      <ID>124</ID> 
      <Name>Smith Family</Name> 
      <Taxable>No</Taxable> 
    </Group>
  </Groups>
</Response>
EXAMPLE URL
https://api.workflowmax.com/clientgroup.api/get/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Group>
    <ID>123</ID> 
    <Name>Bloggs Family</Name> 
    <Taxable>Yes</Taxable> 
    <Clients>
      <Client>
        <ID>193</ID> 
        <Name>Jo Bloggs</Name> 
      </Client>
      <Client>
        <ID>199</ID> 
        <Name>Bloggs Widget Ltd</Name> 
      </Client>
    </Clients>
  </Group>
</Response>
EXAMPLE URL
POST https://api.workflowmax.com/clientgroup.api/add?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Group>
  <Name>Smith Group</Name>  <!-- Name of Group-->
  <Taxable>No</Name>  <!-- Optional taxable group setting for Practice Manager users-->
  <ClientID>12345</ClientID>  <!-- Client to add to group-->
</Group>

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

EXAMPLE URL
PUT https://api.workflowmax.com/clientgroup.api/members?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Group>
  <ID>456</ID>  <!-- ID of Group to add client to-->
   
  <add id="456" />  <!-- ID of client to add to group-->
  <remove id="678" />  <!-- ID of client to remove from group-->
</Group>

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

EXAMPLE URL
POST https://api.workflowmax.com/clientgroup.api/delete?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Group>
  <ID>456</ID>  <!-- ID of Group to be deleted-->
</Group>