Installer.com Docs
API ReferenceWorkflows
GET
/api/clients/{token}/workflows

Path Parameters

token*string

Response Body

application/json

curl -X GET "http://localhost:8000/api/clients/string/workflows"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workflowTemplateId": "53e62d87-459b-4f1f-ae45-ffe2549e140f",
  "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  "routerId": "c3d4372d-3cfa-4618-a60e-50a4c920823d",
  "isAutoDispatchingEnabled": true,
  "customerPortalWelcomeDescription": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Hello world",
            "marks": [
              {
                "type": "bold"
              }
            ]
          }
        ]
      }
    ]
  },
  "updatedAt": "2019-08-24",
  "createdAt": "2019-08-24",
  "steps": [
    {
      "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
      "manualAddition": true,
      "actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518",
      "dispatchesActorId": "4b53a359-41fc-4bb3-aae5-be9591e6b70a",
      "activeStepDataId": "e6677ddb-5fe7-41b4-8896-8ac5afae52a4",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "string",
      "descriptionOperator": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Hello world",
                "marks": [
                  {
                    "type": "bold"
                  }
                ]
              }
            ]
          }
        ]
      },
      "descriptionContractor": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Hello world",
                "marks": [
                  {
                    "type": "bold"
                  }
                ]
              }
            ]
          }
        ]
      },
      "descriptionClient": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Hello world",
                "marks": [
                  {
                    "type": "bold"
                  }
                ]
              }
            ]
          }
        ]
      },
      "dependsOnStepId": "e8ff1ea6-401d-4234-97d5-b3d1846438d8",
      "isRequired": true,
      "type": "booking_create",
      "settings": {
        "useActorsInstallerNetwork": true,
        "isAutoDispatchingEnabled": false,
        "retryOnFailure": false,
        "multipleDispatches": 1,
        "responseDeadlineDays": 10,
        "skipWeekendsForResponseDeadline": false
      },
      "variant": "inspection",
      "index": -2147483648,
      "actor": "operator",
      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
      "autoComplete": true,
      "dueAfterDays": -2147483648,
      "dueAtTime": "string",
      "dueDateSkipWeekends": true,
      "visibleToOperator": true,
      "visibleToContractor": true,
      "visibleToClient": true,
      "data": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
          "workflowStepId": "910ae244-d9b7-47aa-bbbd-fedca7553eff",
          "status": "todo",
          "actionReason": "string",
          "dueAt": "2019-08-24",
          "dueState": "todo",
          "comment": "string",
          "actor": "string",
          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
          "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
          "updatedAt": "2019-08-24T14:15:22Z",
          "createdAt": "2019-08-24T14:15:22Z",
          "deletedAt": "2019-08-24",
          "booking": null,
          "currentStatusLog": {
            "comment": "string",
            "createdAt": "2019-08-24",
            "actor": "string"
          },
          "org": {
            "id": "string",
            "name": "string"
          }
        }
      ],
      "status": "todo",
      "actorVisibility": [],
      "documents": [],
      "backgroundEvents": [],
      "stepActor": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "slug": "string",
        "name": "string",
        "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
        "type": "dispatched",
        "source": "order_creator",
        "activeRepresentativeId": "30df3691-d989-4adf-b59f-de3617255eaa",
        "isMainInstaller": true,
        "professions": [
          "ELECTRICIAN"
        ],
        "services": [
          "AIR_CONDITIONING"
        ]
      },
      "description": null,
      "productTags": []
    }
  ],
  "router": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "actors": [],
  "actor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "slug": "string",
    "name": "string",
    "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
    "type": "dispatched",
    "source": "order_creator",
    "activeRepresentativeId": "30df3691-d989-4adf-b59f-de3617255eaa",
    "isMainInstaller": true,
    "professions": [
      "ELECTRICIAN"
    ],
    "services": [
      "AIR_CONDITIONING"
    ],
    "activeRepresentative": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518",
      "routerId": "c3d4372d-3cfa-4618-a60e-50a4c920823d",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "status": "sent",
      "routingAvailabilityId": "f88ffc45-6c9a-4bef-bd3f-5d28bfc867fe",
      "assignedAt": "2019-08-24T14:15:22Z",
      "revokedAt": "2019-08-24T14:15:22Z",
      "cancellationReason": "TOO_LATE",
      "user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phoneNumber": "string",
        "avatarFileId": "string",
        "fullName": "string",
        "avatarUrl": "string"
      },
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "slug": "string",
        "name": "string"
      }
    },
    "pendingRepresentatives": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518",
        "routerId": "c3d4372d-3cfa-4618-a60e-50a4c920823d",
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
        "status": "sent",
        "routingAvailabilityId": "f88ffc45-6c9a-4bef-bd3f-5d28bfc867fe",
        "assignedAt": "2019-08-24T14:15:22Z",
        "revokedAt": "2019-08-24T14:15:22Z",
        "cancellationReason": "TOO_LATE",
        "user": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "email": "string",
          "firstName": "string",
          "lastName": "string",
          "phoneNumber": "string",
          "avatarFileId": "string",
          "fullName": "string",
          "avatarUrl": "string"
        },
        "tenant": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "slug": "string",
          "name": "string"
        }
      }
    ],
    "tags": []
  },
  "paymentSplitsEnabled": true
}