Get Accounts
get
/rest/v19/accounts
This action returns the list of accounts.
Request
Supported Media Types
- application/json
Query Parameters
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : accounts-collection
Type:
Show Source
object-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : accounts
Type:
Show Source
object-
_crm_custom_AddressLine1:
string
Title:
Address Line 1 -
_crm_custom_AddressLine2:
string
Title:
Address Line 2 -
_crm_custom_addressLine3:
string
Title:
Address Line 3 -
_crm_custom_City:
string
Title:
City -
_crm_custom_Country:
string
Title:
Country -
_crm_custom_county:
string
Title:
County -
_crm_custom_oRCL_OSC_AddressLine1_c:
string
Title:
OSC Address Line 1 -
_crm_custom_oRCL_OSC_AddressLine2_c:
string
Title:
OSC Address Line 2 -
_crm_custom_oRCL_OSC_City_c:
string
Title:
OSC City -
_crm_custom_oRCL_OSC_Country_c:
string
Title:
OSC Country -
_crm_custom_oRCL_OSC_PostalCode_c:
string
Title:
OSC Postal Code -
_crm_custom_oRCL_OSC_State_c:
string
Title:
OSC State -
_crm_custom_PostalCode:
string
Title:
Postal Code -
_crm_custom_State:
string
Title:
State -
companyName:
string
Title:
Company NameThe name of the account. -
customerId:
string
Title:
Customer IdThe unique alternate identifier for the account party. -
customerRep:
string
Title:
Customer RepresentativeName of Sales Account Owner. -
dateAdded:
string
Title:
Date AddedDate Added -
dateModified:
string
Title:
Date ModifiedDate Modified -
email:
string
Title:
EmailThe e-mail address of the account(s) primary contact. -
fax:
string
Title:
FaxThe fax number of the organization in the local format. The number should not include area code, country code, or extension. -
firstName:
string
Title:
First NameThe unique account name displayed on account related screens. -
id:
integer
Title:
IdId -
lastName:
string
Title:
Last NameLast Name -
phone:
string
Title:
PhoneThe phone number of the organization in the local format. The number should not include area code, country code, or extension.
Examples
The following example returns the list of accounts by submitting a GET request to the REST resource using cURL.
curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/accounts
Response Body Sample
The following example shows the contents of the response body in JSON format:
{ {
"hasMore": false,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/accounts"
}
],
"items": [{
"firstName": "Jones Pizza",
"phone": "2135555555",
"companyName": " Jones Pizza",
"customerId": "100",
"email": "ljones@jonespizza.net",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/accounts/100"
}
]
}, {
"firstName": "Smith Trucking",
"phone": "8475555555",
"companyName": "Smith Trucking Incorporated",
"customerId": "102",
"email": "jsmith@smithtruck.com",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/accounts/102"
}
]
}, {
"firstName": "Jackson Rentals",
"phone": "1235555555",
"companyName": "Jackson Rentals",
"customerId": "103",
"email": "mwjackson@jacksonrental.com",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/accounts/103"
}
]
}, {
"firstName": "Morris Foods",
"phone": "3215555555",
"companyName": "Morris Foods",
"customerId": "104",
"email": "jmorris@morrisfoods.net",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/accounts/104"
}
]
}
]
}