Jump to

• Request
• Response
• Examples

Retrieve a list of account groups

get

/api/rest/2.0/assets/account/groups

Retrieves all account groups that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
• lastUpdatedAt: integer
  Unix timestamp for the date and time the account group was last updated.
• orderBy: string
  Specifies the field by which account group results are ordered.
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultAccountGroup

Type: object

Title: QueryResultAccountGroup

Show Source

• elements: array elements
  Array of account group fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultAccountGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of account group fields.",
            "items":{
                "$ref":"#/definitions/AccountGroupRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of account group fields.

Show Source

• Array of: object AccountGroup
  Title: AccountGroup

{
    "type":"array",
    "description":"Array of account group fields.",
    "items":{
        "$ref":"#/definitions/AccountGroupRest20"
    }
}

Nested Schema : AccountGroup

Type: object

Title: AccountGroup

Show Source

• count: string
  The number of companies within the account group. This is a read-only property.
• createdAt: string
  Read Only: true

  The date and time the account group was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the account group.
• currentStatus: string
  The account group's current status. This is a read-only property.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the account group.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the account group.
• id: string
  Read Only: true

  Id of the account group.
• isArchived: string
  The account group is archived or not. This is a read-only property.
• name: string
  The account group's name.
• permissions: array permissions
  The permissions for the account group granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  The date the account group is scheduled.
• sourceTemplateId: string
  Id of the template used to create the account group.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the account group was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the account group.

{
    "title":"AccountGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the account group."
        },
        "currentStatus":{
            "type":"string",
            "description":"The account group's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The account group's name."
        },
        "description":{
            "type":"string",
            "description":"The description of the account group."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the account group granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the account group."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the account group."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the account group."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the account group was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the account group."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the account group was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the account group is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "count":{
            "type":"string",
            "description":"The number of companies within the account group. This is a read-only property."
        },
        "isArchived":{
            "type":"string",
            "description":"The account group is archived or not. This is a read-only property."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the account group granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the account group granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Retrieve the first two account groups in your database:

GET /api/REST/2.0/assets/account/groups?count=2
			

Response:

{
  "elements": [
    {
      "type": "AccountGroup",
      "id": "1",
      "createdAt": "1131727145",
      "depth": "minimal",
      "folderId": "233",
      "name": "New Account Group Name",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update",
        "Activate"
      ],
      "updatedAt": "1474386011",
      "updatedBy": "9"
    },
    {
      "type": "AccountGroup",
      "id": "2",
      "createdAt": "1474375350",
      "createdBy": "9",
      "depth": "minimal",
      "folderId": "49",
      "name": "Hudsucker Industries",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update",
        "Activate"
      ],
      "updatedAt": "1474375350",
      "updatedBy": "9"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 2
}
			

Back to Top