curl --request GET \
--url https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"steps": [
{
"id": "6a8dc78d8d28fe4014b4e507",
"channel": "email",
"type": "manual",
"sequenceNumber": 0,
"daysBetween": 0,
"title": null,
"topic": null,
"subject": null,
"body": null,
"cc": []
},
{
"id": "6a8dce2ef83628aea1088041",
"channel": "email",
"type": "manual",
"sequenceNumber": 1,
"daysBetween": 2,
"title": "probe step subject",
"topic": null,
"subject": "Following up on BrightPay's finance hiring",
"body": "<p>Hi {Contact First Name}, circling back on my note last week.</p>",
"cc": [
"ops@yourcompany.com"
]
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}List a campaign's sequence steps
Lists the campaign’s sequence steps in sequenceNumber order (0-based). A campaign created through this API starts with one empty step per requested channel, so this is how you discover the ids to write content into with PATCH /business/campaigns//steps/. type tells you what to write: manual needs subject and body, ai_generated and ai_reply write from topic. Only the token owner’s own campaigns resolve here. Rate limit: 30 requests/minute and 1,000/day per token owner, shared by every campaign, scheduled-send, campaign-template and knowledge-hub endpoint.
Errors:
404CAMPAIGN_NOT_FOUND— No campaign with this id exists, it belongs to another account (including a campaign delegated to you or shared by your team’s visibility settings), or it has been deleted.422VALIDATION_FAILED— campaignId is not a 24-character hex id.429RATE_LIMITED— More than 30 campaign requests in a minute, or 1,000 in a day, for this token owner (the bucket is shared by every /business/campaigns, /business/scheduled-sends, /business/campaign-templates and /business/knowledge-hubs call).500UNEXPECTED_ERROR— An unhandled failure; the detail stays in our logs and is never returned.
Requires one of the following token scopes: campaigns.
curl --request GET \
--url https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"steps": [
{
"id": "6a8dc78d8d28fe4014b4e507",
"channel": "email",
"type": "manual",
"sequenceNumber": 0,
"daysBetween": 0,
"title": null,
"topic": null,
"subject": null,
"body": null,
"cc": []
},
{
"id": "6a8dce2ef83628aea1088041",
"channel": "email",
"type": "manual",
"sequenceNumber": 1,
"daysBetween": 2,
"title": "probe step subject",
"topic": null,
"subject": "Following up on BrightPay's finance hiring",
"body": "<p>Hi {Contact First Name}, circling back on my note last week.</p>",
"cc": [
"ops@yourcompany.com"
]
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Authorizations
Your API token (af_…) as the Basic-auth username, with an empty password.
Path Parameters
The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.
Response
Success
Show child attributes
Show child attributes