Retrieve a list of syncs
get
/api/bulk/2.0/syncs
Retrieves a list of syncs.
Request
Supported Media Types
- application/json
- text/csv
Query Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : SyncSearchResponse
Type:
object
Title:
Show Source
SyncSearchResponse
-
count:
integer
Title:
count
-
hasMore:
boolean
Title:
hasMore
-
items:
array items
Title:
items
-
limit:
integer
Title:
limit
-
offset:
integer
Title:
offset
-
totalResults:
integer(int64)
Title:
totalResults
Nested Schema : Sync
Type:
object
Title:
Show Source
Sync
-
callbackUrl:
string
Title:
callbackUrl
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
status:
string
Title:
SyncStatusType
Default Value:pending
Allowed Values:[ "pending", "active", "success", "warning", "error" ]
-
syncedInstanceUri:
string
Title:
syncedInstanceUri
-
syncEndedAt:
string(date-time)
Title:
syncEndedAt
-
syncStartedAt:
string(date-time)
Title:
syncStartedAt
-
uri:
string
Title:
uri
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.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to retrieve a list of syncs using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve a list of the first 5 syncs:
GET /syncs?limit=5
Response:
{
"items":[
{
"syncedInstanceUri":"/contacts/exports/1",
"syncStartedAt":"2014-06-17T19:43:41.9700000Z",
"syncEndedAt":"2014-06-17T19:43:42.7800000Z",
"status":"success",
"createdAt":"2014-06-17T19:43:41.9000000Z",
"createdBy":"EloquaSystem",
"uri":"/syncs/1"
},
{
"syncedInstanceUri":"/contacts/exports/2",
"syncStartedAt":"2014-06-17T19:46:09.5830000Z",
"syncEndedAt":"2014-06-17T19:46:10.0830000Z",
"status":"success",
"createdAt":"2014-06-17T19:46:08.8370000Z",
"createdBy":"EloquaSystem",
"uri":"/syncs/2"
},
{
"syncedInstanceUri":"/contacts/exports/3",
"syncStartedAt":"2014-06-17T19:49:37.7900000Z",
"syncEndedAt":"2014-06-17T19:49:38.6770000Z",
"status":"success",
"createdAt":"2014-06-17T19:49:37.9700000Z",
"createdBy":"EloquaSystem",
"uri":"/syncs/3"
},
{
"syncedInstanceUri":"/contacts/exports/4",
"syncStartedAt":"2014-06-17T19:56:34.7670000Z",
"syncEndedAt":"2014-06-17T19:56:38.5800000Z",
"status":"success",
"createdAt":"2014-06-17T19:56:34.5070000Z",
"createdBy":"EloquaSystem",
"uri":"/syncs/4"
},
{
"syncedInstanceUri":"/contacts/exports/5",
"syncStartedAt":"2014-06-17T21:05:28.6100000Z",
"syncEndedAt":"2014-06-17T21:05:29.4400000Z",
"status":"success",
"createdAt":"2014-06-17T21:05:28.3770000Z",
"createdBy":"EloquaSystem",
"uri":"/syncs/5"
}
],
"totalResults":59927,
"limit":5,
"offset":0,
"count":5,
"hasMore":true
}
cURL Example
Here is the same example in cURL given an instance with the name APITest
, username API.User
, and POD of 3
.
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/syncs?limit=5