Terminal provides customers multiple options to associate custom identifiers. This makes it easy to search for data in Terminal using these identifiers.You can assign the following custom identifiers to your connections:External ID
A unique identifier that you can assign to connections, typically mapping to your internal system identifiers. Common uses include:
When you create a connection with Terminal’s Link Component, you can assign custom identifiers by including the external_id or tags parameters.
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.
You can also assign custom identifiers to an existing connection by calling the Update Current Connection API and including the appropriate parameters.
You can search for connections using custom identifiers with the List Connections API. You can search using all or any of the identifier types. For example:
Copy
Ask AI
curl --request GET \ --url 'https://api.withterminal.com/tsp/v1/connections?externalId=new-external-id&tags=customer' \ --header 'Authorization: <authorization>'
This example searches for connections with the external ID new-external-id and tags customer. You can adjust the query parameters to search by any combination of external IDs and tags that suit your needs.