Skip to main content

Get a connection profile

GET 
/api/v1/ConnectionProfile/:id

Returns the full settings of one connection profile, including its custom fields. Reading a profile that has no approval workflow creates an empty one, and reading a profile that has no approval email template assigns the default template; either way the profile is saved.

Permission required: Administrator.

Values for type: 0 = Generic, 1 = ConnectionProfile, 2 = EmailSettings, 3 = System.

Values for approvalTypeRequired: 0 = Deny, 1 = Allow, 2 = Workflow, 3 = External.

Values for activityConfigurationSettings[].type: 0 = String, 1 = Integer, 2 = UnsignedInteger, 3 = Boolean, 4 = Guid.

Values for customFields[].customFieldDataType: 0 = Integer, 1 = String, 2 = Options.

Request​

Responses​

The connection profile.