REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of users

get

/api/REST/1.0/system/users

Retrieves all users 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 complete by default. For more information, see Request depth.
lastUpdatedAt: integer

The date and time the user was last updated. This is a read-only property.
orderBy: string

Specifies the field by which list 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.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : QueryResultUser

Type: object

Title: QueryResultUser

Show Source

elements: array elements

Array of user 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":"QueryResultUser",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of user fields.",
            "items":{
                "$ref":"#/definitions/UserRest10"
            }
        },
        "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 user fields.

Show Source

Array of: object User

Title: User

{
    "type":"array",
    "description":"Array of user fields.",
    "items":{
        "$ref":"#/definitions/UserRest10"
    }
}

Nested Schema : User

Type: object

Title: User

Show Source

company: string

The name of the user's company/instance. This is a read-only property.
createdAt: string

Read Only: true

The date and time the user was created, expressed in Unix time. This is a read-only property.
createdBy: string

Read Only: true

The login id of the user who created the user. This is a read-only property.
currentStatus: string

This property is not used.
defaultAccountViewId: string

The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
defaultContactViewId: string

The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
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 user. This is a read-only property.
emailAddress: string

The user's email address. This is a read-only property.
id: string

Read Only: true

Id of the user. This is a read-only property.
loginName: string

The user's name used to login. This is a read-only property.
name: string

The name of the user. This is a read-only property.
permissions: string

The permissions for the user granted to your current instance. This is a read-only property.
preferences: object UserPreferences

Title: UserPreferences
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 user was last updated. This is a read-only property.
updatedBy: string

Read Only: true

The login id of the user that last updated the user. This is a read-only property.

{
    "title":"User",
    "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 user. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used."
        },
        "name":{
            "type":"string",
            "description":"The name of the user. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the user. This is a read-only property."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the user granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the user. This is a read-only property."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the user. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
        },
        "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>."
        },
        "loginName":{
            "type":"string",
            "description":"The user's name used to login. This is a read-only property."
        },
        "company":{
            "type":"string",
            "description":"The name of the user's company/instance. This is a read-only property."
        },
        "emailAddress":{
            "type":"string",
            "description":"The user's email address. This is a read-only property."
        },
        "preferences":{
            "$ref":"#/definitions/UserPreferencesRest10",
            "description":"A list of user preferences. \"timezoneID\" is identifies the user's timezone preference."
        },
        "defaultContactViewId":{
            "type":"string",
            "description":"The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request."
        },
        "defaultAccountViewId":{
            "type":"string",
            "description":"The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request."
        }
    }
}

Nested Schema : UserPreferences

Type: object

Title: UserPreferences

Show Source

timezoneId: string

The ID of the user's timezone in Eloqua. This is a read-only property.
type: string

The asset's type in Eloqua. This is a read-only property.

{
    "title":"UserPreferences",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID of the user's timezone in Eloqua. This is a read-only property."
        }
    }
}

204 Response

No matching users were found in the search.

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.

Examples

Retrieve the first 2 Oracle Eloqua users in your database in minimal detail:


GET /api/REST/1.0/system/users?count=2&depth=minimal

Response:


{
    "elements": [
        {
            "type": "User",
            "id": "3",
            "createdAt": "1417714078",
            "depth": "minimal",
            "description": "Jack Q. Attack",
            "name": "Jack Q. Attack",
            "updatedAt": "1592856801"
        },
        {
            "type": "User",
            "id": "4",
            "createdAt": "1417714082",
            "depth": "minimal",
            "description": "Dynamo Jones",
            "name": "Dynamo.Jones",
            "updatedAt": "1628261954"
        }
    ],
    "page": 1,
    "pageSize": 2,
    "total": 10283
}