Skip to main content
GET
/
v1
/
accounts
/
{accountId}
/
dripcampaigns
/
{dripCampaignId}
Fetch a drip campaign
curl --request GET \
  --url https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "name": "<string>",
    "trigger": {
      "type": "<string>",
      "delay": {
        "days": 123,
        "hours": 123,
        "minutes": 123
      },
      "message": "<string>",
      "groups": [
        {
          "id": "<string>",
          "name": "<string>",
          "phoneNumbers?": [
            {
              "id": "<string>",
              "status": "<string>",
              "number": "<string>",
              "country": "<string>",
              "type": "<string>",
              "name": "<string>",
              "verified": true,
              "provider": "<string>",
              "supportedDestinations": [
                "<string>"
              ],
              "forwardTo": {},
              "universalReply": true,
              "channels": {
                "sms": {
                  "active": true,
                  "universalReply": true,
                  "supportedDestinations": {},
                  "regulatory": {
                    "brandStatus": "<string>",
                    "campaign": {
                      "id": "<string>",
                      "campaignId": "<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": {
                    "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>",
              "email": "chris@sakari.io",
              "firstName": "Chris",
              "lastName": "Bloggs",
              "mobile": {
                "country": "<string>",
                "number": "123-456-7890",
                "verified": "2023-11-07T05:31:56Z",
                "valid": true,
                "lineType": "mobile"
              },
              "tacAccepted": "2023-11-07T05:31:56Z"
            }
          ],
          "senders": [
            {
              "id": "<string>",
              "type": "phonenumber",
              "subType": "<string>",
              "status": "<string>",
              "identifier": "<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>"
                }
              },
              "channels": {
                "sms": {
                  "active": true,
                  "universalReply": true,
                  "supportedDestinations": {},
                  "regulatory": {
                    "brandStatus": "<string>",
                    "campaign": {
                      "id": "<string>",
                      "campaignId": "<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": {
                    "forwardTo": "<string>",
                    "message": "<string>",
                    "transcribe": true
                  },
                  "features": [
                    "<string>"
                  ]
                },
                "whatsapp": {
                  "active": true
                }
              },
              "groups": [
                {
                  "id": "<string>",
                  "name": "<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
        }
      ],
      "list": {
        "id": "<string>",
        "name": "<string>",
        "source": {
          "id": "<string>",
          "integration": "<string>",
          "lastSynced": "<string>"
        },
        "keyword": "<string>",
        "doubleOptIn": {
          "enabled": true,
          "prompt": "<string>"
        },
        "filter": {
          "q": "<string>",
          "attributes": [
            {
              "attribute": "<string>",
              "comparator": "<string>",
              "value": [
                "<string>"
              ]
            }
          ],
          "list": "<string>",
          "valid": true,
          "invalid": true,
          "blocked": true,
          "unblocked": true,
          "optIn": true
        },
        "optInConfirmation": "<string>"
      },
      "group": {
        "id": "<string>",
        "name": "<string>",
        "phoneNumbers?": [
          {
            "id": "<string>",
            "status": "<string>",
            "number": "<string>",
            "country": "<string>",
            "type": "<string>",
            "name": "<string>",
            "verified": true,
            "provider": "<string>",
            "supportedDestinations": [
              "<string>"
            ],
            "forwardTo": {},
            "universalReply": true,
            "channels": {
              "sms": {
                "active": true,
                "universalReply": true,
                "supportedDestinations": {},
                "regulatory": {
                  "brandStatus": "<string>",
                  "campaign": {
                    "id": "<string>",
                    "campaignId": "<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": {
                  "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>",
            "email": "chris@sakari.io",
            "firstName": "Chris",
            "lastName": "Bloggs",
            "mobile": {
              "country": "<string>",
              "number": "123-456-7890",
              "verified": "2023-11-07T05:31:56Z",
              "valid": true,
              "lineType": "mobile"
            },
            "tacAccepted": "2023-11-07T05:31:56Z"
          }
        ],
        "senders": [
          {
            "id": "<string>",
            "type": "phonenumber",
            "subType": "<string>",
            "status": "<string>",
            "identifier": "<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>"
              }
            },
            "channels": {
              "sms": {
                "active": true,
                "universalReply": true,
                "supportedDestinations": {},
                "regulatory": {
                  "brandStatus": "<string>",
                  "campaign": {
                    "id": "<string>",
                    "campaignId": "<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": {
                  "forwardTo": "<string>",
                  "message": "<string>",
                  "transcribe": true
                },
                "features": [
                  "<string>"
                ]
              },
              "whatsapp": {
                "active": true
              }
            },
            "groups": [
              {
                "id": "<string>",
                "name": "<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
      }
    },
    "messages": [
      {
        "message": "<string>",
        "delay": {
          "days": 123,
          "hours": 123,
          "minutes": 123
        },
        "id": "<string>",
        "media": [
          {
            "url": "<string>",
            "type": "<string>",
            "name": "<string>",
            "filename": "<string>"
          }
        ],
        "stats": {
          "entered": 123,
          "active": 123,
          "errored": 123,
          "noAction": 123,
          "optOut": 123,
          "engaged": 123
        }
      }
    ],
    "id": "<string>",
    "description": "<string>",
    "active": true,
    "maxDuration": 123,
    "stats": {
      "entered": 123,
      "active": 123,
      "errored": 123,
      "noAction": 123,
      "optOut": 123,
      "engaged": 123
    },
    "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>"
      }
    }
  }
}
{
  "success": true,
  "error": {
    "code": "CONT-010",
    "description": "Contact has requested no further communication"
  }
}
{
  "success": true,
  "error": {
    "code": "CONT-010",
    "description": "Contact has requested no further communication"
  }
}

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

​
dripCampaignId
string
required

Drip Campaign to apply operations to

Response

successful operation

​
success
boolean
required
​
data
object
required