Get all sync errors for an app

Last updated September 12, 2019

GET /extensions/ecomm/v2/sync/errors/app/:appId

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Get all of the sync errors for the specified app. This will let you get all of the sync errors across all HubSpot accounts with the app installed.

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, and cannot be used with a custom integration using a API key.
Required Parameters How to use Description
API key hapikey=
Used in the request URL
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
App ID :appId
Used in the request URL
The ID of the app, created inside your HubSpot Developer portal.

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.