Tags are a flexible way to reference, categorize and find your connections in Terminal. Once you’ve tagged a connection, you can use these tags to filter or group connections, making it easier to manage them.

Tags may include identifying information about the connection, such as the user’s “ID” and “email”, or information about the connection’s purpose, such as “Prospect” or “Customer”.

Assigning Tags

During Connection Creation

You can assign tags during connection creation with Terminal’s Link Component by including the tags parameter.

If your application is configured to de-duplicate connections, tags will be added to an existing connection if one exists. Otherwise, a new connection with these tags will be created.

Hosted Flow


React SDK

const terminal = useTerminalLink({
  // production or sandbox publishable key from the Terminal dashboard
  publishableKey: process.env.REACT_APP_TERMINAL_PUBLISHABLE_KEY,
  onSuccess: exchangeToken,
  params: {
    tags: ['tag1', 'tag2']

JavaScript SDK

  // production or sandbox publishable key from the Terminal dashboard
  publishableKey: process.env.TERMINAL_PUBLISHABLE_KEY,
  onSuccess: (result) => exchangePublicToken(result.publicToken),
  params: {
    tags: ['tag1', 'tag2']

After Connection Creation

You can also set the tags associated with an existing connection by calling the Update Current Connection API and including the tags parameter.

Be aware that each call to the Update Current Connection API overwrites existing tags. To add tags, include all desired tags in the request.

curl --request PATCH \
  --url https://api.withterminal.com/tsp/v1/connections/current \
  --header 'Authorization: <authorization>' \
  --header 'Connection-Token: <connection-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tags": ["tag1", "tag2"]

Searching by Tags

You can search for connections by tags using the List Connections API. For example:

curl --request GET \
  --url 'https://api.withterminal.com/tsp/v1/connections?tag=tag' \
  --header 'Authorization: <authorization>'