Errors

When a request is unsuccessful or an error occurs, the API will respond with an HTTP status code in the 400 or 500 range. The response body will contain information about the error that occurred.

{
	"error_code": 4010,
	"message": "Couldn't get list: no list with that id",
	"status_code": 404
}

The API uses standard HTTP status codes to indicate the type of error. Status codes in the 400 range indicate errors resulting from the provided input, for example a missing field or resource not found. Status codes in the 500 range indicate that something went wrong with jsonpad's servers.

If you experience peristent errors with codes in the 500 range, contact support@jsonpad.io so that the error can be investigated.

If jsonpad is undergoing scheduled maintenance, the API will respond with a 503 Service Unavailable status code.

API error codes

Every error returned by the API has a unique error code. The first digit of the error code indicates the type of object with which the error is associated.

1000	Unknown request
The request endpoint or format was unrecognised. See Routes for a list of valid routes.

1001	Content type must be 'application/json'
You must set the Content-Type header to application/json when sending POST, PUT or PATCH requests.

1002	Accept header must be 'application/json'
You must set the Accept header to application/json for all requests.

1003	Access denied
No user authentication credentials were provided via HTTP basic auth, or the provided credentials were incorrect. See Security and authentication for further information.

1004	API rate limit exceeded
The number of requests for the current rate limit period was exceeded. See Rate limiting for further information.

1005	SSL is required
All connections to the API must use HTTPS.

Event error codes

2000	Couldn't create event: object type is invalid
The API tried to log an event with an invalid object type.

2001	Couldn't create event: action is invalid
The API tried to log an event with an invalid action type.

2002	Couldn't get event: no event with that id
The requested event was not found.

2003	Couldn't get events: the specified list does not exist
The requested list was not found.

2004	Couldn't get events: no item with that id in the specified list
The requested item was not found.

2005	Couldn't get events: object type is invalid
The API tried to fetch events associated with an invalid object type.

Item error codes

3000	Couldn't create item: data is not valid JSON
An item couldn't be created because the data was not valid JSON.

3001	Couldn't create item: data size is too large
An item couldn't be created because the item's data field was larger than the item data size limit. See Limitations for further information.

3002	Couldn't create item: the specified list does not exist
An item couldn't be created in the specified list because the list was not found.

3003	Couldn't get items: the specified list does not exist
The requested list was not found.

3004	Couldn't update item: data is not valid JSON
An item couldn't be updated because the data was not valid JSON.

3005	Couldn't update item: data size is too large
An item couldn't be updated because the item's data field was larger than the item data size limit. See Limitations for further information.

3006	Couldn't delete items: the specified list does not exist
An item couldn't be deleted from the specified list because the list was not found.

3007	Couldn't get item: the specified list does not exist
The requested list was not found.

3008	Couldn't get item: no item with that id in the specified list
The requested item was not found in the specified list.

3009	Couldn't create item: unknown error
An unknown error occurred while creating an item.

3010	Couldn't update item: the specified list does not exist
An item couldn't be updated in the specified list because the list was not found.

3011	Couldn't update item: no item with that id in the specified list
The requested item was not found in the specified list.

3012	Couldn't update item: unknown error
An unknown error occurred while updating an item.

3013	Couldn't delete item: the specified list does not exist
An item couldn't be deleted from the specified list because the list was not found.

3014	Couldn't delete item: no item with that id in the specified list
The requested item was not found in the specified list.

3015	Couldn't delete item: unknown error
An unknown error occurred while deleting an item.

3016	Couldn't delete items: unknown error
An unknown error occurred while deleting items from a list.

3017	Couldn't create item: maximum number of items has been reached for this list
An item couldn't be created in the specified list because the list has reached the maximum number of items. See Limitations for further information.

3018	Couldn't update item: (JSON patch error message)
An item couldn't be updated because there was a problem with the JSON patch data. The precise error will be specified in the error message.

3019	Couldn't get item data: (JSON pointer error message)
A value could not be fetched from the requested item's data because there was a problem with the JSON pointer. The precise error will be specified in the error message.

3020	Couldn't get one or more items' data: (JSON pointer error message)
Values could not be fetched from the requested items because there was a problem with the JSON pointer. The precise error will be specified in the error message.

3021	Couldn't update item data: (JSON pointer error message)
An item couldn't be updated because there was a problem with the JSON pointer. The precise error will be specified in the error message.

3022	Couldn't append item data: the requested property is not an array
A value couldn't be appended to an item's data because the requested property is not an array.

3023	Couldn't create item: the data failed to validate against the list schema
An item couldn't be created in the specified list because the item's data does not validate against the list's schema. The precise error(s) will be listed in the validation_errors array in the response body.

3024	Couldn't update item: the data failed to validate against the list schema
An item couldn't be updated because the item's data does not validate against the list's schema. The precise error(s) will be listed in the validation_errors array in the response body.

3025	Couldn't create item: maximum data size limit has been reached
An item couldn't be created because the total data size limit has been reached for your account.

3026	Couldn't update item: maximum data size limit has been reached
An item couldn't be updated because it would exceed the total data size limit for your account.

List error codes

4000	Couldn't create list: field 'name' is missing or empty
A list couldn't be created because the name field was missing or empty. See Lists for a summary of required list fields.

4001	Couldn't create list: name is already in use
A list couldn't be created because you already have a list with the same name.

4002	Couldn't update list: field 'name' is missing or empty
A list couldn't be updated because the new name field was missing or empty. See Lists for a summary of required list fields.

4003	Couldn't update list: the specified list does not exist
The requested list was not found.

4004	Couldn't update list: name is already in use
A list couldn't be updated because you already have a list with the same name.

4005	Couldn't delete list: the specified list does not exist
The requested list was not found.

4006	Couldn't create list: unknown error
An unknown error occurred while creating a list.

4007	Couldn't update list: unknown error
An unknown error occurred while updating a list.

4008	Couldn't delete list: unknown error
An unknown error occurred while deleting a list.

4009	Couldn't delete lists: unknown error
An unknown error occurred while deleting lists.

4010	Couldn't get list: no list with that name
The requested list was not found.

4011	Couldn't create list: maximum number of lists has been reached
A list couldn't be created because the maximum number of lists has been reached. See Limitations for further information.

4012	Couldn't create list: data is not valid JSON
A list couldn't be created because the list data was not valid JSON.

4013	Couldn't get list schema: no list with that name
The requested list was not found.

4014	Couldn't create list: field 'indexes' is not an array
A list couldn't be created because the indexes field was defined but it was not an array. It should contain a list of indexes - see Indexes for further information.

User error codes

5011	Couldn't update user: field 'timezone' is missing or invalid
The current user's timezone couldn't be updated because the timezone field was missing or not a valid timezone. See Timestamps for further information.

5017	Couldn't authenticate user: API token is empty
A user account couldn't be authenticated because the provided API token was missing or empty. See Security and authentication for further information.

5025	Couldn't update timezone: unknown error
An unknown error occurred while updating the current user's timezone.

Index error codes

6000	Couldn't create index: field 'name' is missing or empty
An index couldn't be created because the name field was missing or empty. See Indexes for a summary of required index fields.

6001	Couldn't create index: field 'path' is missing or empty
An index couldn't be created because the path field was missing or empty. See Indexes for a summary of required index fields.

6002	Couldn't create index: field 'type' is missing or empty
An index couldn't be created because the type field was missing or empty. See Indexes for a summary of required index fields.

6003	Couldn't create index: field 'default_descending' is missing or empty
An index couldn't be created because the default_descending field was missing or empty. See Indexes for a summary of required index fields.

6004	Couldn't create index: type is invalid
An index couldn't be created because the type field is not a valid index type. See Index value types for a summary of valid index value types.

6005	Couldn't create index: name is already in use
An index couldn't be created because there is already an index in the specified list with the same name.

6006	Couldn't get indexes: the specified list does not exist
The requested list was not found.

6007	Couldn't get index: the specified list does not exist
The requested list was not found.

6008	Couldn't get index: no index with that name in the specified list
The requested index was not found in the specified list.

6009	Couldn't create index: name is disallowed
An index couldn't be created because the name field is a reserved word. See Reserved index names for further information.

6010	Couldn't index item data: unknown error
An unknown error occurred while indexing an item's data.

Realtime error codes

7000	Unknown request
The request path was unrecognised. See Realtime for a list of valid paths.

7001	Missing authentication credentials
No user authentication credentials were provided via HTTP basic auth.

7002	Authentication credentials incorrect
A user account couldn't be authenticated because the provided API username or realtime token was incorrect.

7010	Couldn't verify resource ownership
An unknown error occurred while verifying resource ownership.