Page tree
Skip to end of metadata
Go to start of metadata

List organizationgroups

Lists groups to which organizations can belong.

Request

HTTP GET to /organizationgroups

Filter

Name

Required

Example

Description

Data Type

id

no

id=1

Only show the group with the given id

ID

Example:

APIURL/organizationgroups.xml?apikey=338934897438

Response

Name

Example

Description

Data Type

id

<id>1</id>

Unique ID

ID

name

<name>Groupname</name>

Name of group

String

businessunitid<businessunitid>1</businessunitid>ID of business unitID
<organizationgroups>
  <organizationgroup>
    <id>3</id>
    <name>Groupname1</name>
    <businessunitid>1</businessunitid>
  </organizationgroup>
  <organizationgroup>
    <id>2</id>
    <name>Groupname2</name>
    <businessunitid>1</businessunitid>
  </organizationgroup>
  <organizationgroup>
    <id>1</id>
    <name>Groupname3</name>
    <businessunitid>1</businessunitid>
  </organizationgroup>
</organizationgroups>
{
    "organizationgroups":  [
                         {
                             "id":  3,
                             "name":  "Groupname1",
                             "businessunitid":  1
                         },
                         {
                             "id":  2,
                             "name":  "Groupname1",
                             "businessunitid":  1
                         },
                         {
                             "id":  1,
                             "name":  "Groupname1",
                             "businessunitid":  1
                         }
                     ]
}
  • No labels