action

Return all actions in the organization paginated

get/v1/org/{orgId}/action

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/action
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fromstring

Action id to start paginating from

limitinteger

Number of results to return

assessmentIdstring

Retrieve actions associated with an assessment

formIdstring

Retrieve actions associated with a form

stepTypestring

Filter to actions containing at least one step of the given type(s), for example: ai,signature

agentUserIdstring

Filter to actions containing an AI step assigned to the given agent user

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "cronSchedule": "5 4 * * *",
      "steps": [
        {
          "stepId": "588f7ee98f138b19220041a7",
          "formId": "588f7ee98f138b19220041a7",
          "templateId": "588f7ee98f138b19220041a7",
          "aiAgentUserId": "588f7ee98f138b19220041a7",
          "aiApprovedPolicyRules": [
            {
              "departmentIds": [
                "588f7ee98f138b19220041a7"
              ],
              "filter": "department:engineering and under:me",
              "targets": [
                {
                  "personId": "588f7ee98f138b19220041a7"
                }
              ]
            }
          ]
        }
      ],
      "runUserId": "588f7ee98f138b19220041a7",
      "categoryId": "588f7ee98f138b19220041a7",
      "assessmentId": "588f7ee98f138b19220041a7",
      "formId": "588f7ee98f138b19220041a7",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 20 revisions of this API.