Skip to content

Headers & Query Parameters

Headers and query parameters let you attach fixed or dynamic values to every connector request. Both support Jinja2 templates so you can inject user context, secrets, or other runtime values.

Headers

Add one or more header pairs using Header Key and Header Value. Use this for things like content type, API versioning, or auth headers.

Example values:

  • Header Key: Content-TypeHeader Value: application/json
  • Header Key: AcceptHeader Value: application/vnd.api+json;version=1

Query parameters

Add one or more parameter pairs using Query Key and Query Value. Use this for filters, search terms, pagination, or API keys.

Example values:

  • Query Key: qQuery Value:
jinja2
{{ user.email }}
  • Query Key: limitQuery Value: 50

Overridable fields

Each header or query parameter has an Overridable checkbox. By default it is off, which means the value is always included in every request and cannot be changed at run time. Turn Overridable on when the caller should be able to change the value for a specific request.

When a field is marked as Overridable and no override is provided at run time, the configured value is used as the default. The field is still sent — it is never omitted just because no override was given.

Identity fields should not be overridable

If a query parameter or header carries user identity (such as a user ID or email), keep Overridable off and set the value to a server-side template variable like {{ user.id }}. This ensures the value is injected on the server and cannot be changed by browser code. See Passing User Context for details.

Next Steps

Gainsight CC Developer Portal