Error Codes

||

When an API request fails, the Showpad API returns an error response with details to help you diagnose and resolve the issue.

What you'll learn:

• Interpret HTTP status codes and Showpad error codes
• Understand error categories (parameter, persistence, validation, body)
• Troubleshoot common API errors

TL;DR

• HTTP status codes? 4xx = client error, 5xx = server error. Check the general category first.
• Showpad error codes? 2xxx = parameter, 3xxx = persistence, 4xxx = validation, 5xxx = body. Decode the specific issue.
• Quick fix? Check the code and name in the response to identify the exact issue

caution

The contents of this page are not applicable for Content Reporting.

Example Error Response

When an error occurs, the API returns a JSON response with error details:

{
  "response": {
    "code": 3004,
    "name": "ResourceNotFoundError",
    "message": "The requested resource could not be found"
  }
}

HTTP Status Codes

The Showpad API uses standard HTTP status codes to indicate the success or failure of a request.

Code	Status	Description
200	OK	Request succeeded
201	Created	Resource created successfully
204	No Content	Request succeeded with no response body
400	Bad Request	Invalid request syntax or parameters
401	Unauthorized	Missing or invalid authentication token
403	Forbidden	Valid token but insufficient permissions
404	Not Found	Resource doesn't exist
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server-side error

How to Read Showpad Error Codes

Showpad uses a numbering scheme to categorize errors:

Code Range	Category	Description
2xxx	Parameter Errors	Invalid query parameters
3xxx	Persistence Errors	Database or resource issues
4xxx	Validation Errors	Data doesn't meet requirements
5xxx	Body Errors	Invalid request body format

Parameter Errors

Parameter errors occur when an incorrect query parameter has been entered.

Code	Name	Description
2001	InvalidParameterError	Parameter value is invalid
2002	NegativeParameterError	Parameter cannot be negative
2003	NotNumericParameterError	Parameter must be a number
2004	NotIntegerParameterError	Parameter must be an integer

Persistence Errors

Persistence errors occur when an operation cannot be completed because it is not possible on a data level. For example, if an unknown ID is submitted, a ResourceNotFoundError will be returned.

Code	Name	Description
3000	PersistenceError	General persistence error
3001	RelationshipDoesNotExistError	Referenced relationship doesn't exist
3002	RelationshipExistsError	Relationship already exists
3003	RelationshipNotFound	Relationship not found
3004	ResourceNotFoundError	Resource with given ID doesn't exist
3005	SubcollectionNotFoundError	Subcollection not found
3006	UnableToDeleteError	Resource cannot be deleted
3007	RelationshipUnsupportedError	Relationship type not supported
3008	ResourceNotModifiableError	Resource cannot be modified

Validation Errors

Validation errors occur when an operation cannot be completed because the entity or entities being submitted do not conform to Showpad requirements. For example, if a username is already registered, a NotUniqueValidationError will be returned.

Body Errors

Body errors are returned when the format entered in the request's body is invalid.

Code	Name	Description
5000	InvalidBodyError	Request body is invalid
5001	InvalidJsonBodyError	JSON syntax is malformed
5002	TooManyResourcesInBodyError	Too many items in request body

Troubleshooting Common Errors

Error	Common Cause	Solution
401 Unauthorized	Expired or missing token	Generate a new API token
403 Forbidden	Insufficient scopes	Check your OAuth client's scope settings
ResourceNotFoundError	Invalid ID	Verify the resource ID exists and you have access
IsRequiredValidationError	Missing required field	Check the API reference for required parameters
InvalidJsonBodyError	Malformed JSON	Validate your JSON syntax before sending

tip

Use the Test API Requests feature to quickly debug errors with real data.

Need Help?

If you're encountering persistent errors that you can't resolve, contact Showpad Support for assistance.

Next Steps

• API Testing - Test requests directly in the documentation
• Authentication - Resolve token and permission issues
• API Reference - Full endpoint specifications and parameters