Skip to main content
GET
/
api
/
PartnerActions
/
{partnerActionId}
Get a Partner Action.
curl --request GET \
  --url https://api.example.com/api/PartnerActions/{partnerActionId}
{
  "partnerActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "typeId": 1,
  "workflowTypeId": 0,
  "url": "<string>",
  "urlTypeId": 0,
  "statusId": 0,
  "partnerReference": "<string>"
}

Path Parameters

​
partnerActionId
string<uuid>
required

Response

OK

​
partnerActionId
string<uuid>
required

Unique Identifer for Partner Action ( This is required to update Partner Action in subsequent requests )

​
createdDate
string<date-time>
required

Created Date ( UTC ) of Partner Action

​
updatedDate
string<date-time>
required

Most recent Update Date ( UTC ) of Partner Action

​
name
string
required

Label for Menu item in Recruit Wizard

Minimum string length: 1
​
typeId
enum<integer>
required
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
​
workflowTypeId
enum<integer>
required
Available options:
0,
1,
2,
3,
4
​
url
string
required

URL that Partner Action Triggers. Placeholders can be used to pass across record info. {ClientID}, {ContactID}, {CandidateID}, {OpportunityID}, {JobID}, {PlacementID}, {UserID}

Minimum string length: 1
​
urlTypeId
enum<integer>
required
Available options:
0,
1
​
statusId
enum<integer>
required
Available options:
0,
1
​
partnerReference
string | null

Unique Integration Partner defined Identifier