Make a custom API request to the GoodHire API
There are two types of API: * Partner - If you are an HR platform that will act as a partner to GoodHire and allow the employers on your platform to order GoodHire background reports, please refer to API documentation here. * Customer - If you are a single company that will be ordering background reports directly from GoodHire, please refer to API documentation here.
Options
Request Type (dropdown) - Available HTTP Request Methods. Choose from GET, POST, PUT, PATCH, and DELETE. Refer to API docs in order to determine which request type to use.
GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.
POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. Additional documentation here.
PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. Additional documentation here.
PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.
DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). Additional documentation here.
Input Fields
Request
Relative URL (string) - Relative request URL. This is everything that comes after the base endpoint. Note that you need to specify the API version number in this field:
Example: /v1/Company
Query (object) - Query parameters for the request:
Example: {"record_type":"documentation"}Headers (object) - Any additional headers that you need for your request. You do not need to enter “Authorization” header, as it will be added to the call when it runs:
Example: {"Content-type":"text/html"}Body (object) (only for POST, PUT, PATCH, and DELETE) - Body of the request:
Example: {"foo": "automation, "bar": "integration"}
Output Fields
- Response
- Status Code (number) - The status code of the HTTP response. Here is a list of all status codes.
- Headers (object) - The response headers. A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.
- Body (object) - The response body. Depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.