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
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • 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.
  • The date and time the user was last updated. This is a read-only property.
  • Specifies the field by which list results are ordered.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultUser
Type: object
Title: QueryResultUser
Show Source
Nested Schema : elements
Type: array
Array of user fields.
Show Source
Nested Schema : User
Type: object
Title: User
Show Source
Nested Schema : UserPreferences
Type: object
Title: UserPreferences
Show Source

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.
Back to Top

Examples

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


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

Response:


{
    "elements":[
        {
            "type":"User",
            "id":"1",
			"company":"Acme",
			"emailAddress":"Jack.Attack@test.oracle.com",
			"loginName":"Jack.Attack",
            "createdAt":"1402937945",
            "createdBy":"10",
            "depth":"minimal",
            "description":"Jack Q. Attack",
            "name":"J.Q.Attack",
            "updatedAt":"1402937945",
            "updatedBy":"10"
        },
        {
            "type":"User",
            "id":"2",
			"company":"Acme",
			"emailAddress":"Dynamo.Jones@test.oracle.com",
			"loginName":"Dynamo.Jones",
            "createdAt":"1402938268",
            "createdBy":"11",
            "depth":"minimal",
            "description":"Dynamo Jones",
            "name":"Dynamo.Jones",
            "updatedAt":"1402938268",
            "updatedBy":"11"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":12
}
			
Back to Top