Skip to main content

API - Search Companies - Response Codes & Troubleshooting

When using the Search Companies endpoint on Surfe, your request may return different response codes depending on the outcome. Here’s a simple guide to what they mean and what to do next.


Search Companies

Endpoint: POST v2/companies/search


A successful request is accompanied by a 20X status code that confirms the operation was completed as expected.

200 – Successful

  • What it means: The request worked, and the companies you're searching for have been found.

  • Next steps: You're good to go! Use the results as needed.


In case of errors, the API responds with 4XX or 5XX status codes:

400 – Invalid Request

  • What it means: Something is wrong with the request. A 400 with input_validation_failed means a filter value isn't in the accepted list. For example, an unrecognised technology, technology category or hiring.departments value. The response names the field and the rejected value.

  • Next steps: Double-check the request format. Make sure all required fields are filled out correctly. If you're unsure, refer to the API DOCS (Search Companies)


401 - Unauthorised

  • What it means: Your API key is missing or incorrect.

  • Next steps: Make sure you’ve included your API key in the request. You can find or manage your key in your Surfe account dashboard.


402 – Not Enough Credits

  • What it means: Your account does not have enough search credits to complete this request. Search Companies deducts ⌈results / 10⌉ search credits per call when credit charging is enabled.

  • Next steps: Check your search credit balance via the Get Credits endpoint (GET /v1/credits). To enable or top up search credits contact api.support@surfe.com.


403 – Forbidden

  • What it means: The request cannot be handled because the daily quota has been exceeded or the request would exceed the quota.

  • Next steps: The response will provide the details and date of the quota reset and the limit used. 


429 – Too Many Requests

  • What it means: You've exceeded the rate limit by sending too many requests too quickly.

  • Next steps: Slow down your requests and try again. The rate limit resets every minute. You can send up to 10 requests per second, with bursts of up to 20 occasionally.


500 – Internal Server Error

  • What it means: Something went wrong on our end.

  • Next steps: Try the request again after a short break. If the problem continues, please reach out to the support team.


 

Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request
Return to top

Comments

0 comments

Please sign in to leave a comment.