Use filters that are supported by the underlying provider requests
Passthrough query parameters allow users to inject custom parameters directly into underlying provider APIs. This feature enhances flexibility, enabling more specific and customizable API calls without needing to be supported by our .
When invoking our unified API, you can provide query parameters to customize the API response. A passthrough query parameter is a special parameter that can be included in your API request, which will be directly passed on to the underlying provider API.
The passthrough query mechanism uses a specific parameter pattern – the keyword “proxy” followed by brackets. If any parameter in this format is present in the API call, it will be extracted and passed as a query parameter to the underlying provider API.
Pattern: proxy[custom-query-name]=custom-query-value
custom-query-name
: The name of the custom query parameter.custom-query-value
: The value assigned to the custom query parameter.Note:
More advanced filters are also supported: proxy[filter[eq][age]]=25
.
Using the proxy
passthrough parameter to set page-related parameter (eg: page limits, offsets, size etc.) may result in unexpected behaviour as it will override the values that StackOne sends with every provider request
Suppose you use the unified API to get all candidates for category. This API already supports some optional filters, such as the page_size
query parameter. If you know that one of the underlying providers supports a specific filter called my-custom-filter
, you can use the passthrough query parameter to include this in your request, and it will be used when calling the provider API.
API Request: https://api.stackone.com/unified/ats/candidates?proxy[my-custom-filter]=123
With the above request, while the page_size=20
parameter will be interpreted by our unified API, the proxy[my-custom-filter]=123
will be extracted and passed directly to the underlying provider API as my-custom-filter=123
.
Sorting candidates by the First Name for TeamTailor API:
https://api.stackone.com/unified/ats/candidates?page_size=20&proxy[sort]=first_name
Although it’s great to have the flexibility to use all the filters that the underlying provider supports, you should consider the following caveats when using this functionality:
Passthrough query parameters provide a powerful way to enhance the capabilities of your API calls, giving you direct access to features and filters of underlying provider APIs. Developers can create more customized API requests by understanding the tradeoffs and leveraging this mechanism.
Use filters that are supported by the underlying provider requests
Passthrough query parameters allow users to inject custom parameters directly into underlying provider APIs. This feature enhances flexibility, enabling more specific and customizable API calls without needing to be supported by our .
When invoking our unified API, you can provide query parameters to customize the API response. A passthrough query parameter is a special parameter that can be included in your API request, which will be directly passed on to the underlying provider API.
The passthrough query mechanism uses a specific parameter pattern – the keyword “proxy” followed by brackets. If any parameter in this format is present in the API call, it will be extracted and passed as a query parameter to the underlying provider API.
Pattern: proxy[custom-query-name]=custom-query-value
custom-query-name
: The name of the custom query parameter.custom-query-value
: The value assigned to the custom query parameter.Note:
More advanced filters are also supported: proxy[filter[eq][age]]=25
.
Using the proxy
passthrough parameter to set page-related parameter (eg: page limits, offsets, size etc.) may result in unexpected behaviour as it will override the values that StackOne sends with every provider request
Suppose you use the unified API to get all candidates for category. This API already supports some optional filters, such as the page_size
query parameter. If you know that one of the underlying providers supports a specific filter called my-custom-filter
, you can use the passthrough query parameter to include this in your request, and it will be used when calling the provider API.
API Request: https://api.stackone.com/unified/ats/candidates?proxy[my-custom-filter]=123
With the above request, while the page_size=20
parameter will be interpreted by our unified API, the proxy[my-custom-filter]=123
will be extracted and passed directly to the underlying provider API as my-custom-filter=123
.
Sorting candidates by the First Name for TeamTailor API:
https://api.stackone.com/unified/ats/candidates?page_size=20&proxy[sort]=first_name
Although it’s great to have the flexibility to use all the filters that the underlying provider supports, you should consider the following caveats when using this functionality:
Passthrough query parameters provide a powerful way to enhance the capabilities of your API calls, giving you direct access to features and filters of underlying provider APIs. Developers can create more customized API requests by understanding the tradeoffs and leveraging this mechanism.