GET
/
v1
/
accounts
/
{accountId}
/
workflows
Fetch Account Workflows
curl --request GET \
  --url https://api.sakari.io/v1/accounts/{accountId}/workflows \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pagination": {
    "totalCount": 123,
    "limit": 123,
    "offset": 123,
    "hasNext": true
  },
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "versions": [
        {
          "id": "<string>",
          "name": "<string>",
          "definition": {
            "nodes": [
              {
                "id": "<string>",
                "type": {
                  "id": "<string>",
                  "type": "<string>",
                  "group": "<string>",
                  "name": "<string>",
                  "label": "<string>",
                  "description": "<string>",
                  "icon": "<string>",
                  "properties": [
                    {
                      "label": "<string>",
                      "helperText": "<string>",
                      "link": "<string>",
                      "type": "basictext",
                      "mandatory": true,
                      "args": [
                        "<string>"
                      ],
                      "options": [
                        {
                          "value": "<string>",
                          "label": "<string>"
                        }
                      ],
                      "min": 123,
                      "max": 123,
                      "defaultValue": "<string>",
                      "name": "<string>",
                      "conditions": [
                        {
                          "property": "<string>",
                          "comparator": "<string>",
                          "value": "<string>"
                        }
                      ]
                    }
                  ],
                  "outputs": [
                    {
                      "default": true,
                      "path": "<string>",
                      "name": "<string>",
                      "dataType": "boolean"
                    }
                  ],
                  "validation": {
                    "numEdgeCondition": "exactly",
                    "numEdges": 123,
                    "edges": [
                      {
                        "type": "timeout",
                        "value": {
                          "mandatory": true,
                          "editable": true,
                          "value": "<string>",
                          "default": "<string>"
                        },
                        "multiple": true,
                        "defaultEdge": true
                      }
                    ]
                  },
                  "supportsReenrollment": true,
                  "color": "<string>",
                  "status": "<string>",
                  "supportLink": "<string>"
                },
                "config": {
                  "message": "<string>",
                  "groups": [
                    {
                      "id": "<string>",
                      "name": "<string>",
                      "phoneNumbers?": [
                        {
                          "id": "<string>",
                          "name": "<string>",
                          "status": "<string>",
                          "number": "<string>",
                          "country": "<string>",
                          "type": "<string>",
                          "verified": true,
                          "provider": "<string>",
                          "supportedDestinations": [
                            "<string>"
                          ],
                          "forwardTo": {},
                          "universalReply": true,
                          "channels": {
                            "sms": {
                              "active": true,
                              "universalReply": true,
                              "supportedDestinations": {},
                              "regulatory": {
                                "brandStatus": "<string>",
                                "campaign": {
                                  "id": "<string>",
                                  "useCase": "<string>"
                                },
                                "pft": true,
                                "submitted": "2023-11-07T05:31:56Z",
                                "approved": "2023-11-07T05:31:56Z",
                                "rejected": "2023-11-07T05:31:56Z"
                              }
                            },
                            "voice": {
                              "active": true,
                              "incoming": {
                                "action": "forward",
                                "forwardTo": "<string>",
                                "message": "<string>",
                                "transcribe": true
                              },
                              "features": [
                                "<string>"
                              ]
                            },
                            "whatsapp": {
                              "active": true
                            }
                          },
                          "groups": [
                            {
                              "id": "<string>",
                              "name": "<string>"
                            }
                          ],
                          "hosted": true
                        }
                      ],
                      "notifications": [
                        {
                          "destination": {
                            "id": "<string>",
                            "name": "<string>"
                          },
                          "integration": "<string>",
                          "group": {
                            "id": "<string>",
                            "name": "<string>"
                          }
                        }
                      ],
                      "tags": [
                        "<string>"
                      ],
                      "users": [
                        {
                          "id": "<string>",
                          "firstName": "<string>",
                          "lastName": "<string>",
                          "email": "<string>",
                          "mobile": {
                            "country": "<string>",
                            "number": "123-456-7890",
                            "verified": "2023-11-07T05:31:56Z",
                            "valid": true,
                            "lineType": "mobile"
                          },
                          "role": "Administrator"
                        }
                      ],
                      "senders": [
                        {
                          "id": "<string>",
                          "type": "phonenumber",
                          "subType": "<string>",
                          "status": "<string>",
                          "identifier": "<string>",
                          "channels": {
                            "sms": {
                              "active": true,
                              "universalReply": true,
                              "supportedDestinations": {},
                              "regulatory": {
                                "brandStatus": "<string>",
                                "campaign": {
                                  "id": "<string>",
                                  "useCase": "<string>"
                                },
                                "pft": true,
                                "submitted": "2023-11-07T05:31:56Z",
                                "approved": "2023-11-07T05:31:56Z",
                                "rejected": "2023-11-07T05:31:56Z"
                              }
                            },
                            "voice": {
                              "active": true,
                              "incoming": {
                                "action": "forward",
                                "forwardTo": "<string>",
                                "message": "<string>",
                                "transcribe": true
                              },
                              "features": [
                                "<string>"
                              ]
                            },
                            "whatsapp": {
                              "active": true
                            }
                          },
                          "groups": [
                            {
                              "id": "<string>",
                              "name": "<string>"
                            }
                          ],
                          "created": {
                            "at": "2023-11-07T05:31:56Z",
                            "by": {
                              "id": "<string>",
                              "name": "Joe Bloggs",
                              "firstName": "Joe",
                              "lastName": "Bloggs",
                              "email": "joe@bloggs.com",
                              "source": "<string>",
                              "subSource": "<string>"
                            }
                          },
                          "updated": {
                            "at": "2023-11-07T05:31:56Z",
                            "by": {
                              "id": "<string>",
                              "name": "Joe Bloggs",
                              "firstName": "Joe",
                              "lastName": "Bloggs",
                              "email": "joe@bloggs.com",
                              "source": "<string>",
                              "subSource": "<string>"
                            }
                          }
                        }
                      ],
                      "officeHours": {
                        "active": true,
                        "timezone": "<string>",
                        "times": {
                          "sun": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "mon": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "tue": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "wed": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "thu": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "fri": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ],
                          "sat": [
                            {
                              "start": {
                                "hour": 123,
                                "minute": 123
                              },
                              "end": {
                                "hour": 123,
                                "minute": 123
                              }
                            }
                          ]
                        }
                      },
                      "isDefault": true,
                      "useSharedPool": true
                    }
                  ]
                }
              }
            ],
            "edges": [
              {
                "id": "<string>",
                "type": "standard",
                "source": "<string>",
                "target": "<string>",
                "value": "<string>"
              }
            ],
            "properties": [
              {
                "name": "<string>",
                "dataType": "string",
                "created": {
                  "at": "2023-11-07T05:31:56Z"
                }
              }
            ]
          },
          "readonly": true,
          "active": "2023-11-07T05:31:56Z",
          "lastActive": "2023-11-07T05:31:56Z",
          "created": {
            "at": "2023-11-07T05:31:56Z",
            "by": {
              "id": "<string>",
              "name": "Joe Bloggs",
              "firstName": "Joe",
              "lastName": "Bloggs",
              "email": "joe@bloggs.com",
              "source": "<string>",
              "subSource": "<string>"
            }
          },
          "updated": {
            "at": "2023-11-07T05:31:56Z",
            "by": {
              "id": "<string>",
              "name": "Joe Bloggs",
              "firstName": "Joe",
              "lastName": "Bloggs",
              "email": "joe@bloggs.com",
              "source": "<string>",
              "subSource": "<string>"
            }
          }
        }
      ],
      "created": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<string>",
          "name": "Joe Bloggs",
          "firstName": "Joe",
          "lastName": "Bloggs",
          "email": "joe@bloggs.com",
          "source": "<string>",
          "subSource": "<string>"
        }
      },
      "updated": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<string>",
          "name": "Joe Bloggs",
          "firstName": "Joe",
          "lastName": "Bloggs",
          "email": "joe@bloggs.com",
          "source": "<string>",
          "subSource": "<string>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
string
required

Account to apply operations to

Query Parameters

offset
integer

Results to skip when paginating through a result set

Required range: x >= 0
limit
integer

Maximum number of results to return

Required range: 1 <= x <= 100
type
string

Type of Workflow

Response

200
application/json

successful operation

The response is of type object.