API Reference

A brief general reference of several components of Surereach API.

API Interfaces

References of individual interfaces are documented in their respective sections. Navigate through following links to quickly get started with either of these.

• ENDPOINTS
• UTILITY ENDPOINTS

API Max Concurrency Limit

Surereach API enforces a max concurrency limit of 5 request per 10 seconds within the API to prevent abuse of the API. If user exceeds the max concurrency limit then API terminates with status code 429.

You can always increase up your max concurrency limit by changing the API plan or contacting us directly.

API Error Status Codes

Surereach API returns different status codes depending on different error cases. They're listed below.

Status Code	Reason Phrase	Error Code	Description
400	Bad Request	bad_request	Something went wrong while parsing user request.
400	Bad Request	options_validation_failed	Something wrong with options or API parameters.
401	Bad Request	missing_token	Token is missing. Please provide proper Authorization header with Bearer token.
401	Bad Request	invalid_token	Your token is invalid. Please ensure that correct token is being used.
401	Bad Request	expired_token	Your token is expired.
401	Bad Request	invalid_token	Your token(signature) is invalid.
401	Bad Request	revoked_token	This account has been disabled.
401	Bad Request	invalid_referral_code	The referral code is not valid.
401	Bad Request	invalid_file_format	Invalid type of file is passed.
401	Bad Request	invalid_report_type	Reported invalid issue.
401	Forbidden	Insufficient credits	Not enough credits in wallet.
403	Forbidden	User not verified	User is not verified.
403	Bad Request	Unable to read the given file	Unable to read the given file. Please ensure the file is not corrupted.
403	Bad Request	Missing Required Column	File missing a required column 'linkedin_url'. This column should contain valid Linkedin URLs.
403	Limit Exceed	Teams limit exceeded	Owners can only have up to 5 teams.
403	Forbidden	User is not allowed to create a team	User doesn't have access to create a team, Please contact the admin to allow.
403	Not Resolved	Linkedin bulk request not resolved.	The requested bulk requests is not resolved yet.
403	Forbidden	Bulk submit not allowed	User doesn't have access to use bulk upload API. Please contact the admin to allow the access
404	Not Found	Data not found	Data Not Found.
404	Not Found	Linkedin bulk requests not found	Linkedin bulk request not found for the current user.
404	Not Found	Team with the given ID not found	There is no team exist associated with current user
404	Not Found	Could not find director details	Director data not found
404	Not Found	User not found	User not found
405	Bad Request	method not allowed	You can requesting with unexpected request type. You need to change the request type.
409	Bad Request	User not found	User not found
409	Bad Request	Report already exists	Report already exists, Please do not report the same report again
409	Bad Request	A team owner cannot become a team member	A team owner cannot become a member of the team.
409	Bad Request	Member already exists in a team	The requested member already member of the team.
409	Bad Request	Your phone is blacklisted	Your phone is blacklisted, Please contact support.
409	Bad Request	Your company is blacklisted	Your company is blacklisted, Please contact support.
409	Lock Error	`Same operation is already processing	Maximum number of OTP submit exceeded, please try after some time.
410	OTP Expired	OTP Expired	OTP is expired, please resend the OTP again.
429	Rate Limited	Wait for a few seconds to resend OTP	Wait for a few seconds to resend OTP again.
429	Request Rate Limited	Rate Limited	The API reached the max concurrency limit.
500	Internal Server Error Occurred	contact_support	Something went wrong with Surereach API servers.

Example API Error Response

{
    "data": null,
    "error": null,
    "message": "Your token is expired.",
    "status_code": 401,
    "success": false,
    "message_code": "expired_token"
}

API Credits Usage

Each request to the Surereach API incurs 1 credit unless there has been some internal server error or some unexpected exception with the API itself.