# Gupy Public API

**Gupy Public API** integrates with [Gupy’s API](https://developers.gupy.io/) to manage job postings, candidates, and applications. It enables automated recruitment workflows by allowing pipelines to interact with HR-related data.

## **Parameters**

Take a look at the configuration parameters for the connectors. Parameters supported by [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Account</strong></td><td>The account used by the connector. Supported type: <a href="/spaces/jvO5S91EQURCEhbZOuuZ/pages/fS1QLzAg8rGSSJFwtrvy#accounts-type"><strong>OAuth Bearer</strong></a>.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **API tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Host</strong> <code>(DB)</code></td><td>The base URL of the Gupy API.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Path</strong></td><td>The specific Gupy endpoint to be accessed. The selected path determines the available operations and required configurations. Refer to the <a href="https://developers.gupy.io/">Gupy API documentation</a> for details on each endpoint.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Method</strong></td><td>The HTTP method used for the request.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Settings tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Connect Timeout (ms)</strong></td><td>Maximum time allowed for establishing a connection, in milliseconds.</td><td>30000</td><td>Integer</td></tr><tr><td><strong>Read Timeout (ms)</strong></td><td>Maximum time allowed for reading data, in milliseconds.</td><td>30000</td><td>Integer</td></tr><tr><td><strong>Stop on Client Error</strong></td><td>When enabled, stops the pipeline execution if a 4xx HTTP error occurs.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Stop on Server Error</strong></td><td>When enabled, stops the pipeline execution if a 5xx HTTP error occurs.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Override Response Charset</strong></td><td>When enabled, replaces the charset returned by the endpoint with the one specified in the <strong>Response Charset</strong> property. Otherwise, the charset from the <strong>Content-Type</strong> header is used.</td><td>True</td><td>Boolean</td></tr><tr><td><strong>Response Charset</strong></td><td>Defines the charset to be used when <strong>Override Response Charset</strong> is enabled. Default: UTF-8.</td><td>UTF-8</td><td>String</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/industry-solutions/gupy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.