This is a typical response format you will get when you successfully call our API. response.results will differ based on the endpoint you're calling.
// success response{ success:true, error:null, results: { data: { projects: [],//...your projects projectsCount:10,// the total number of projects returned }, meta: { totalProjects:20,// total project you have page:1,// current page limit:10,// the limit, totalPages:2// total pages available. } }}
No Authorization Header
Our API returns this response when you don't provide Authorization header.
// No Authorization Header error response.{ success:false, error: { message:"No authorization header provided.", messageDetail:"Please make sure to provide Authorization header." }, results:null}
Invalid API Key
Our API returns this response if you failed to provide a valid API Key.
// Invalid API Key error response.{ success:false, error: { message:"Invalid API Key.", messageDetail:"Please make sure to provide a valid API Key." }, results:null}
Pagination errors
Here is an example pagination error.
// Invalid page or limit value error response.{ success:false, error: { message:"Invalid `page` or `limit` value.", messageDetail:"Please make sure that `page` and `limit` values are greater than 0." }, results:null}
Another pagination error.
// Invalid `limit` value error response.{ success:false, error: { message:"Invalid `limit` value.", messageDetail:"Please make sure that `limit` value is less than or equal to 20." }, results:null}
And other one for page value
// Invalid `page` value error response.{ success:false, error: { message:"Invalid `page` value.", messageDetail:"Please make sure that `page` value is less than or equal to total pages. Total pages: 2" }, results:null}