Get all sync errors for a specific account

Last updated September 12, 2019

GET /extensions/ecomm/v2/sync/errors/portal

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Get all of the sync errors for the specified HubSpot account. This endpoint will only work for a custom integration using the API key for the account.

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 designed to work only with a custom integration, using the API key for the HubSpot account. This endpoint will not work when using OAuth tokens.
Required Parameters How to use Description
API key hapikey=
Used in the request URL
The API key of the HubSpot account that you want to get the errors for..

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.