Retrieve a user

get

/api/REST/1.0/system/user/{id}

Retrieves the user specified by the id parameter. For security purposes, full user details are only displayed in a response if the user profile being retrieved via the API is the same user performing the request.

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : User
Type: object
Title: User
Show Source
Nested Schema : UserPreferences
Type: object
Title: UserPreferences
Show Source

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

When logged into Eloqua as user id = 2, retrieve full details for the user with id = 2:


GET /api/REST/1.0/system/user/2?depth=complete
			

Response:


{
    "type":"User",
    "id":"2",
    "createdAt":"1422464363",
    "createdBy":"10",
    "depth":"complete",
    "description":"Api "Test" User",
    "name":"api.user",
    "updatedAt":"1424794552",
    "updatedBy":"2",
    "betaAccess":[
        "cloud_content",
        "cloud_content",
        "emailCampaignDesigner",
        "enable_email_deliverability_testing",
        "FormExtIntegration",
        "processing_step_lookups",
        "whitelistFrameableResponse",
        "galactus",
        "ics_links",
        "image_replace_e10",
        "rest1legacySecurity",
        "requestLoggingOutbound",
        "Content_Feed",
        "sfdcBulkApi",
        "VerisignDNS",
        "prevent_creation_of_old_template"
    ],
    "capabilities":[],
    "company":"PlatformTeamPod1",
    "defaultAccountViewId":"100003",
    "defaultContactViewId":"100001",
    "emailAddress":"api.user@oracle.com",
    "interfacePermissions":[ ... ],
    "loggedInAt":"1435844824",
    "loginName":"Api.User",
    "preferences":{
        "type":"UserPreferences",
        "timezoneId":"64"
    },
    "productPermissions":[
        {
            "type":"ProductPermission",
            "productCode":"EngageiPad"
        },
        {
            "type":"ProductPermission",
            "productCode":"EngageWeb"
        }
    ],
    "typePermissions":[
        {
            "type":"TypePermission",
            "objectType":"Campaign",
            "permissions":{
                "type":"TypePermissions",
                "create":"true"
            }
        },
        {
            "type":"TypePermission",
            "objectType":"Email",
            "permissions":{
                "type":"TypePermissions",
                "create":"true"
            }
        },
        {
            "type":"TypePermission",
            "objectType":"Form",
            "permissions":{
                "type":"TypePermissions",
                "create":"true"
            }
        },
        {
            "type":"TypePermission",
            "objectType":"LandingPage",
            "permissions":{
                "type":"TypePermissions",
                "create":"true"
            }
        },
       ...
        }
    ]
}
			

Note:

When retrieving the details for the user you are currently logged in as, the detail shown in the response body above is displayed. If you are retrieving a user you are not currently logged in as, less user detail is returned.
Back to Top