Skip to main content

Errors

Every error of the App API is an RFC 7807 problem, application/problem+json, whose type is the address of its page here: https://dev.positive-app.fr/errors/<code>. Match on type, never on title or detail: those are for people and may change.

{
"type": "https://dev.positive-app.fr/errors/scope-missing",
"title": "Scope missing",
"status": 403,
"detail": "The installation was not granted the scope \"read_products\"."
}
StatusErrorTitleMeaning
400invalid-cursorInvalid cursorThe pagination cursor is not valid for this installation, resource and filters.
400invalid-parameterInvalid parameterA query or body parameter is missing, malformed or out of range; the detail names it.
403forbidden-for-appsForbidden for appsAn installation token was sent to a route that is not part of the App API. An installed app can call /api/app/v1 only.
403marketplace-disabledMarketplace disabledThe marketplace is not enabled on this platform, so no app can use the App API there.
403scope-missingScope missingThe installation was not granted a scope this operation needs.
404not-foundNot foundThe resource does not exist, or it belongs to an organization the installation does not cover: the API does not tell the two apart.
429rate-limitedToo many requestsThe installation exceeded its request budget.
503marketplace-unavailableMarketplace unavailableThe marketplace service behind the operation cannot answer right now.

A 401 answer has no problem type of its own: the token is missing, expired or revoked, or the installation was uninstalled or suspended. Refresh the token once; if it is still refused, stop calling the API for that installation.