Skip to main content
Get Workflow Goal

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

workflowGoalId
integer<int32>
required

The identifier of the WorkflowGoal object

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

OK

Workflow goal carrier Carrier object for WorkflowGoal. Services for the WorkflowGoal Carrier is available from the Workflow Agent.

WorkflowGoalId
integer<int32>

Primary key

WorkflowId
integer<int32>

The flow this goal belongs to

GoalType
enum<string>

The workflow goal type

Available options:
None,
PersonUpdated,
SaleCreatedOnPerson,
SaleCreatedOnCompany,
AppointmentCreated,
AddedToProject,
AddedToSelection,
FormSubmitted,
HadChat,
LinkClicked,
RequestCreated
RestrictionGroups
object[]

The restrictions (can be multiple groups) that make up the Workflow goal criteria

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.