GET
/
hubs
/
{hub_id}
/
users
/
{user_id}
/
connections

Path Parameters

hub_id
string
required
user_id
string
required

UserID references an End User in the Hub.

Most APIs support setting this value to either the internal Versori identifier or their external ID as determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is being used.

Query Parameters

identifier_type
enum<string>
default: external

IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an external identifier. If the value is external, some endpoints also require the hub query parameter to identify the correct Hub.

Available options:
internal,
external
first
integer
default: 20
before
string
after
string
hub_connector_id
string[]

Search is a string that is used to filter the list of Connections. The search string is matched against the name.

Response

200 - application/json

ConnectorConnectionPage defines a page of Connection summaries.

totalCount
integer
required
next
string
prev
string
connections
object[]
connections.id
string
required

ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the name in combination with the Connector's id instead.

connections.name
string
required

Name is the name of the Connection.

connections.createdAt
string
required

CreatedAt is the time the Connection was created.

connections.updatedAt
string
required

UpdatedAt is the time the Connection was last updated.