Get all sync errors for a specific account from a specific app

Last updated June 17, 2020

GET /extensions/ecomm/v2/sync/errors

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Required Scope:

integration-sync

Get all of the sync errors for your app, from a specific HubSpot account. This endpoint is used with an OAuth access token, and will return the errors for the app and account associated with the provided access token.

Errors are tracked by the externalObjectId. Only the most recent error will be included for each externalObjectId, and a successful sync for a given externalObjectId will mark the error as resolved.

Note: This endpoint is only used with an installed app using OAuth access tokens, and cannot be used with a custom integration using a API key.
Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters How to use Description
Include resolved errors &includeResolved=true
Used in the request URL		 Whether or not to include resolved errors in the response. Defaults to false.
Error type  &errorType=
Used in the request URL

Filter the results to the specified error type.

Must be one of:

  • INACTIVE_PORTAL
  • NO_SYNC_SETTINGS
  • SETTINGS_NOT_ENABLED
  • NO_MAPPINGS_DEFINED
  • MISSING_REQUIRED_PROPERTY
  • NO_PROPERTIES_DEFINED
  • INVALID_ASSOCIATION_PROPERTY
  • INVALID_DEAL_STAGE
  • INVALID_EMAIL_ADDRESS
  • INVALID_ENUM_PROPERTY
  • UNKNOWN_ERROR
 Object Type

&objectType=
Used in the request URL 

Filter the results to the specific object type.

Must be one of:

  • CONTACT
  • DEAL
  • PRODUCT
  • LINE_ITEM
     
Limit &limit=
Used in the request URL		 The number of errors returned. Defaults to the maximum of 200.
Page &page=
Used in the request URL		 Used to get the next set of results. Starts at 1, so &page=2 gets you the second page or errors.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET request: https://api.hubapi.com/extensions/ecomm/v2/sync/errors/ Example response: The returned errors will be for the app and HubSpot account associated with the provided OAuth access token: { "results": [ { "portalId": 12345, "storeId": "example-store-id", "objectType": "CONTACT", "externalObjectId": "003", "changedAt": 1507642200000, "erroredAt": 1525730425475, "type": "MISSING_REQUIRED_PROPERTY", "details": "Sync settings SyncKey{objectType=CONTACT, portalId=12345, externalObjectId=003}, missing required properties [email], message [SyncHadoopHubspotPropertyValue{hubspotPropertyName=ip__ecomm_bridge__ecomm_synced, propertyValue=true, timestamp=1507642200000}]", "status": "OPEN" }, { "portalId": 678910, "storeId": "another-example-store", "objectType": "CONTACT", "externalObjectId": "001", "changedAt": 1507642200000, "erroredAt": 1525730425968, "type": "MISSING_REQUIRED_PROPERTY", "details": "Sync settings SyncKey{objectType=CONTACT, portalId=678910, externalObjectId=001}, missing required properties [email], message [SyncHadoopHubspotPropertyValue{hubspotPropertyName=ip__ecomm_bridge__ecomm_synced, propertyValue=true, timestamp=1507642200000}]", "status": "OPEN" }, // ... ], "paging": { "next": { "page": "2", "link": "?page=2&limit=200" } } }