GetContactGroups

Allows you to retrieve a list of all the contact groups, or a single contact group with all its contacts (ContactID and Name).

Properties

Authentication

Authentication values used to connect to the Xero server.

Contact group id / name

You can retrieve an individual record by specifying the ContactGroupID or Name.

Where

Restrict the returned items using the specified criteria. See Where filter.

Order by

Return items in a specific order. See Order by filter.

Return options

Select how the data is to be returned. Possible values are:

  • Only the first item.
  • The first item or an empty item.
  • All the items one by one.
  • All of the items at once.


Output

Return type of ContactGroups

A list of contact groups or a single contact group depending on the selected Return option (see above).


Xero Developer: Contact Groups (GET)