v1

latestOpenAPI 3.1.02026-07-241050242.7 KB

/automationsPeople

Get a list of pairings of Automations and the People on which they have or will be run.

get/automationsPeople

Query parameters

personIdinteger

ID of a Person (i.e. to view only pairings for that Person)

automationIdinteger

ID of an Automation (i.e. to view only pairings for that Automation)

status'"Initial"' | '"Running"' | '"Paused"' | '"Completed"'

Automation Status to filter by, i.e. one of "Initial", "Running", "Paused", or "Completed"

Response

200

Example response

{
  "_metadata": {
    "collection": "automationsPeople",
    "limit": 10,
    "total": 2
  },
  "automationsPeople": [
    {
      "id": 2,
      "created": "2023-08-09T21:36:05Z",
      "updated": "2023-08-09T21:36:05Z",
      "createdById": -1,
      "updatedById": -1,
      "createdBy": "Follow Up Boss",
      "updatedBy": "Follow Up Boss",
      "personId": 2,
      "automationId": 1,
      "status": "Completed",
      "automationName": "Test Automation"
    }
  ]
}