Get an account group

get

/services/rest/connect/v1.4/accountGroups/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : accountGroups
Type: object
The Account Groups allow staff accounts to be grouped for better organization.
Show Source
  • accountGroups-attributes
    The group of flags that can be associated with account group.
  • The date and time when the account group was created. This attribute is read-only.
  • accountGroups-descriptions
    The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The order in which this account group is displayed relative to other members of the same group.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the account group.
  • Maximum Length: 255
    The name used to look up the account group.
  • Maximum Length: 80
    The name of the account group in the language of the current interface. This attribute is read-only.
  • accountGroups-names
    The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
  • The date and time when the account group was last updated. This attribute is read-only.
Nested Schema : accountGroups-attributes
Type: object
The group of flags that can be associated with account group.
Show Source
Nested Schema : accountGroups-descriptions
Type: object
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
Show Source
Nested Schema : accountGroups-names
Type: object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
Nested Schema : namedIDs-accountGroups-descriptions-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accountGroups-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Back to Top

Examples

Use GET with the following syntax to retrieve data for an account group object:

https://your_site_interface/services/rest/connect/version/accountGroups/accountGroup_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133

Response example

{
    "id": 100133,
    "lookupName": "NewAccountGroupName1",
    "attributes": {
        "customerCareAccess": false
    },
    "descriptions": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/descriptions"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/descriptions/{description_id}",
                "templated": true
            }
        ]
    },
    "displayOrder": 2,
    "name": "NewAccountGroupName1",
    "names": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/names"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/names/{name_id}",
                "templated": true
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accountGroups",
            "mediaType": "application/schema+json"
        }
    ]
}
Back to Top