Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

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

Last updated July 15, 2019

GET /extensions/ecomm/v2/sync/errors

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

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.