XExeroapi
Accounting

Retrieves a specific contact group by using a unique contact group Id

get/ContactGroups/{ContactGroupID}

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/ContactGroups/{ContactGroupID}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.contacts, accounting.contacts.read

Path parameters

ContactGroupIDstring uuid required

Unique identifier for a Contact Group

Response

Success - return response of type Contact Groups array with a specific Contact Group

Example response

{
  "ContactGroups": [
    {
      "Contacts": [
        {
          "UpdatedDateUTC": "/Date(1573755038314)/",
          "BrandingTheme": {
            "CreatedDateUTC": "/Date(1573755038314)/"
          },
          "BatchPayments": {
            "BankAccountNumber": "123-456-1111111",
            "BankAccountName": "ACME Bank",
            "Details": "Hello World",
            "Code": "ABC",
            "Reference": "Foobar"
          },
          "Attachments": [
            {
              "AttachmentID": "00000000-0000-0000-0000-000000000000",
              "FileName": "xero-dev.jpg",
              "Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
              "MimeType": "image/jpg"
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 62 revisions of this API.