### Example GET /users/email/:email Response

Source: https://developers.activecampaign.com/reference/get-user-email

This is an example response when retrieving a user by their email address. It includes user details and links to related resources.

```json
{
  "user": {
    "username": "somebody",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@example.com",
    "phone": "",
    "signature": null,
    "links": {
      "lists": "https://:account.api-us1.com/api/3/users/1/lists",
      "userGroup": "https://:account.api-us1.com/api/3/users/1/userGroup",
      "dealGroupTotals": "https://:account.api-us1.com/api/3/users/1/dealGroupTotals",
      "dealGroupUsers": "https://:account.api-us1.com/api/3/users/1/dealGroupUsers",
      "configs": "https://:account.api-us1.com/api/3/users/1/configs"
    },
    "id": "1"
  }
}
```

--------------------------------

### GET /users/me API Response Example

Source: https://developers.activecampaign.com/reference/get-user-loggedin

This is an example response for the GET /users/me endpoint, showing the structure of user data returned.

```json
{
  "user": {
    "username": "jdoe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@example.com",
    "phone": "",
    "signature": null,
    "links": {
      "lists": "https://:account.api-us1.com/api/3/users/1/lists",
      "userGroup": "https://:account.api-us1.com/api/3/users/1/userGroup",
      "dealGroupTotals": "https://:account.api-us1.com/api/3/users/1/dealGroupTotals",
      "dealGroupUsers": "https://:account.api-us1.com/api/3/users/1/dealGroupUsers",
      "configs": "https://:account.api-us1.com/api/3/users/1/configs"
    },
    "id": "1"
  }
}
```

--------------------------------

### Example Response for GET /users/username/:username

Source: https://developers.activecampaign.com/reference/get-user-username

This is an example of a successful response when retrieving a user by their username. It includes the user's details and links to related resources.

```json
{
  "user": {
    "username": "admin",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@example.com",
    "phone": "",
    "signature": null,
    "links": {
      "lists": "https://:account.api-us1.com/api/3/users/1/lists",
      "userGroup": "https://:account.api-us1.com/api/3/users/1/userGroup",
      "dealGroupTotals": "https://:account.api-us1.com/api/3/users/1/dealGroupTotals",
      "dealGroupUsers": "https://:account.api-us1.com/api/3/users/1/dealGroupUsers",
      "configs": "https://:account.api-us1.com/api/3/users/1/configs"
    },
    "id": "1"
  }
}
```

--------------------------------

### Create a new list request example

Source: https://developers.activecampaign.com/reference/create-new-list

Use this example to create a new list. Ensure all required fields such as name, stringid, sender_url, and sender_reminder are provided.

```json
{
  "list": {
    "name": "Name of List",
    "stringid": "Name-of-list",
    "sender_url": "http://activecampaign.com",
    "sender_reminder": "You are receiving this email as you subscribed to a newsletter when making an order on our site.",
    "send_last_broadcast": 0,
    "carboncopy": "",
    "subscription_notify": "",
    "unsubscription_notify": "",
    "user": 1
  }
}
```

--------------------------------

### GET /taskOutcomes/:id Request Example

Source: https://developers.activecampaign.com/reference/retrieve-a-task-outcome

This example shows the structure of a GET request to retrieve a specific task outcome by its ID. It includes the expected response body.

```json
GET /taskOutcomes/:id (Example REQUEST)
{
    "taskOutcome": {
        "title": "Interested",
        "sentiment": "POSITIVE",
        "disabled": "0",
        "created_by": "1",
        "updated_by": "1",
        "created_utc_timestamp": "2021-02-16T12:26:15-06:00",
        "updated_utc_timestamp": "2021-02-16T12:27:56-06:00",
        "dealTasktype_ids": [],
        "links": {
            "tasktypeOutcomeRels": "https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels",
            "dealTasks": "https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks"
        },
        "id": "1"
    }
}
```

--------------------------------

### POST /deals Example Response (201 Created)

Source: https://developers.activecampaign.com/reference/create-a-deal-new

This example shows a successful response when creating a deal. It includes details of the created deal and associated contact information.

```json
{
  "contacts": [
    {
      "adate": "2017-02-06 15:50:11",
      "bounced_date": "0000-00-00",
      "bounced_hard": "0",
      "bounced_soft": "0",
      "cdate": "2017-02-03T11:26:41-06:00",
      "deleted": "0",
      "edate": "0000-00-00 00:00:00",
      "email": "johndoe@example.com",
      "email_domain": "",
      "email_local": "",
      "firstName": "",
      "gravatar": "1",
      "hash": "e1705a92f24edf5313ed21df44d6ff5f",
      "id": "51",
      "ip": "0",
      "lastName": "",
      "links": {
        "bounceLogs": "/api/3/contacts/51/bounceLogs",
        "contactAutomations": "/api/3/contacts/51/contactAutomations",
        "contactData": "/api/3/contacts/51/contactData",
        "contactDeals": "/api/3/contacts/51/contactDeals",
        "contactGoals": "/api/3/contacts/51/contactGoals",
        "contactLists": "/api/3/contacts/51/contactLists",
        "contactLogs": "/api/3/contacts/51/contactLogs",
        "contactTags": "/api/3/contacts/51/contactTags",
        "deals": "/api/3/contacts/51/deals",
        "fieldValues": "/api/3/contacts/51/fieldValues",
        "geoIps": "/api/3/contacts/51/geoIps",
        "notes": "/api/3/contacts/51/notes",
        "organization": "/api/3/contacts/51/organization",
        "plusAppend": "/api/3/contacts/51/plusAppend",
        "scoreValues": "/api/3/contacts/51/scoreValues",
        "trackingLogs": "/api/3/contacts/51/trackingLogs"
      },
      "organization": null,
      "orgid": "0",
      "phone": "",
      "rating_tstamp": "0000-00-00",
      "segmentio_id": "",
      "sentcnt": "0",
      "socialdata_lastcheck": "0000-00-00 00:00:00",
      "ua": "",
      "udate": "2017-02-03T11:26:41-06:00"
    }
  ],
    "deal": {
        "description": "This deal is an important deal",
        "currency": "usd",
        "percent": null,
        "status": 0,
        "title": "AC Deal",
        "value": 45600,
        "organization": 45,
        "contact": 1,
        "group": "1",
        "owner": "1",
        "stage": "1",
        "cdate": "2019-12-09T12:29:33-06:00",
        "mdate": "2019-12-09T12:29:33-06:00",
        "nextdate": null,
        "hash": "c3a5497c",
        "winProbability": null,
        "winProbabilityMdate": null,
        "links": {
            "dealActivities": "/api/3/deals/51/dealActivities",
            "contact": "/api/3/deals/51/contact",
            "contactDeals": "/api/3/deals/51/contactDeals",
            "group": "/api/3/deals/51/group",
            "nextTask": "/api/3/deals/51/nextTask",
            "notes": "/api/3/deals/51/notes",
            "account": "/api/3/deals/51/account",
            "customerAccount": "/api/3/deals/51/customerAccount",
            "organization": "/api/3/deals/51/organization",
            "owner": "/api/3/deals/51/owner",
            "scoreValues"
          }
      }
}
```

--------------------------------

### Example RESPONSE for GET /contacts/:id/accountContacts

Source: https://developers.activecampaign.com/reference/retrieve-contact-account-contacts

This is an example JSON response when retrieving account contacts for a contact. It lists associated accounts and their details.

```json
{
    "accountContacts": [
        {
            "account": "9",
            "contact": "7",
            "jobTitle": "",
            "createdTimestamp": "2021-05-21T16:30:23-05:00",
            "updatedTimestamp": "2021-05-21T16:30:23-05:00",
            "links": {
                "account": "https://:account.api-us1.com/api/3/accountContacts/7/account",
                "contact": "https://:account.api-us1.com/api/3/accountContacts/7/contact"
            },
            "id": "7"
        }
    ]
}
```

--------------------------------

### Create User Request Example

Source: https://developers.activecampaign.com/reference/create-user

This example demonstrates the structure of a request body to create a new user. It includes essential user details such as username, name, email, password, and group ID.

```json
{
  "user": {
    "username": "jdoe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@example.com",
    "password": "myPa$$w0rd",
    "group": 4
  }
}
```

--------------------------------

### Create Order Request Example

Source: https://developers.activecampaign.com/reference/create-order

This example demonstrates the structure of a request to create an order. Ensure all required fields are populated correctly.

```json
{
  "ecomOrder": {
    "externalid": "3246315233",
    "source": "1",
    "email": "alice@example.com",
    "orderProducts": [
      {
        "externalid": "PROD12345",
        "name": "Pogo Stick",
        "price": 4900,
        "quantity": 1,
        "category": "Toys",
        "sku": "POGO-12",
        "description": "lorem ipsum...",
        "imageUrl": "https://example.com/product.jpg",
        "productUrl": "https://store.example.com/product12345"
      },
      {
        "externalid": "PROD23456",
        "name": "Skateboard",
        "price": 3000,
        "quantity": 1,
        "category": "Toys",
        "sku": "SK8BOARD145"
      }
    ],
    "totalPrice": 7900,
    "currency": "USD",
    "connectionid": 12345,
    "customerid": 67890,
    "externalCreatedDate": "2023-10-26T10:00:00Z",
    "abandonedDate": "2023-10-26T10:00:00Z"
  }
}
```

--------------------------------

### Example Response for GET /contacts

Source: https://developers.activecampaign.com/reference/list-all-contacts

This is an example of the JSON response when retrieving contacts. It includes detailed information for each contact and links to related resources.

```json
GET /contacts (Example RESPONSE)
{
   "contacts":[
      {
         "cdate":"2017-01-25T23:58:14-06:00",
         "email":"janedoe@example.com",
         "phone":"3120000000",
         "firstName":"John",
         "lastName":"Doe",
         "orgid":"0",
         "segmentio_id":"",
         "bounced_hard":"0",
         "bounced_soft":"0",
         "bounced_date":"0000-00-00",
         "ip":"0",
         "ua":"",
         "hash":"31e076c964f4262817f9ba302c96e1c6",
         "socialdata_lastcheck":"0000-00-00 00:00:00",
         "email_local":"",
         "email_domain":"",
         "sentcnt":"0",
         "rating_tstamp":"0000-00-00",
         "gravatar":"3",
         "deleted":"0",
         "adate":"2017-02-22 15:26:24",
         "udate":"2017-01-25T23:58:14-06:00",
         "edate":"2017-01-27 14:44:13",
         "scoreValues":[

         ],
         "links":{
            "bounceLogs":"https://:account.api-us1.com/api/:version/contacts/68/bounceLogs",
            "contactAutomations":"https://:account.api-us1.com/api/:version/contacts/68/contactAutomations",
            "contactData":"https://:account.api-us1.com/api/:version/contacts/68/contactData",
            "contactGoals":"https://:account.api-us1.com/api/:version/contacts/68/contactGoals",
            "contactLists":"https://:account.api-us1.com/api/:version/contacts/68/contactLists",
            "contactLogs":"https://:account.api-us1.com/api/:version/contacts/68/contactLogs",
            "contactTags":"https://:account.api-us1.com/api/:version/contacts/68/contactTags",
            "contactDeals":"https://:account.api-us1.com/api/:version/contacts/68/contactDeals",
            "deals":"https://:account.api-us1.com/api/:version/contacts/68/deals",
            "fieldValues":"https://:account.api-us1.com/api/:version/contacts/68/fieldValues",
            "geoIps":"https://:account.api-us1.com/api/:version/contacts/68/geoIps",
            "notes":"https://:account.api-us1.com/api/:version/contacts/68/notes",
            "organization":"https://:account.api-us1.com/api/:version/contacts/68/organization",
            "plusAppend":"https://:account.api-us1.com/api/:version/contacts/68/plusAppend",
            "trackingLogs":"https://:account.api-us1.com/api/:version/contacts/68/trackingLogs",
            "scoreValues":"https://:account.api-us1.com/api/:version/contacts/68/scoreValues"
         },
         "id":"68",
         "organization":null
      },
      {
         "cdate":"2017-02-09T12:14:58-06:00",
         "email":"aaronallen@example.com",
         "phone":"",
         "firstName":"Aaron",
         "lastName":"Allen",
         "orgid":"14",
         "segmentio_id":"",
         "bounced_hard":"0",
         "bounced_soft":"0",
         "bounced_date":"0000-00-00",
         "ip":"0",
         "ua":"",
         "hash":"31b92c033c3e55de6d9eb9c44ee1bfa5",
         "socialdata_lastcheck":"0000-00-00 00:00:00",
         "email_local":"",
         "email_domain":"",
         "sentcnt":"0",
         "rating_tstamp":"0000-00-00",
         "gravatar":"1",
         "deleted":"0",
         "adate":"2017-03-16 13:18:12",
         "udate":"2017-02-09T12:14:58-06:00",
         "edate":"0000-00-00 00:00:00",
         "scoreValues":[

         ],
        "accountContacts": [
            "1"
         ],
         "links":{
            "bounceLogs":"https://:account.api-us1.com/api/:version/contacts/73/bounceLogs",
            "contactAutomations":"https://:account.api-us1.com/api/:version/contacts/73/contactAutomations",
            "contactData":"https://:account.api-us1.com/api/:version/contacts/73/contactData",
            "contactGoals":"https://:account.api-us1.com/api/:version/contacts/73/contactGoals",
            "contactLists":"https://:account.api-us1.com/api/:version/contacts/73/contactLists",
            "contactLogs":"https://:account.api-us1.com/api/:version/contacts/73/contactLogs",
            "contactTags":"https://:account.api-us1.com/api/:version/contacts/73/contactTags"

```

--------------------------------

### Create Task Request Example

Source: https://developers.activecampaign.com/reference/create-task

This example demonstrates the structure of a request to create a new task. Ensure all required fields like `relid`, `duedate`, and `dealTasktype` are provided.

```json
{
  "dealTask": {
    "title": null,
    "ownerType": "contact",
    "relid": "7",
    "status": 0,
    "note": "Testing Task",
    "duedate": "2017-02-25T12:00:00-06:00",
    "edate": "2017-02-25T12:15:00-06:00",
    "dealTasktype": "1",
    "assignee": 2,
    "triggerAutomationOnCreate": 100,
    "doneAutomation": 101
  }
}
```

--------------------------------

### Create Pipeline Request Example

Source: https://developers.activecampaign.com/reference/create-a-pipeline

This example demonstrates the structure of a request body to create a new pipeline. It includes parameters for title, currency, user assignment, and group permissions.

```json
{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "currency": "eur",
    "title": "Qualifications",
    "users": [
      "3",
      "4"
    ]
  }
}
```

--------------------------------

### GET /campaigns/:id/links Response Example

Source: https://developers.activecampaign.com/reference/retrieve-links-associated-campaign

This is an example JSON response when retrieving links associated with a campaign. It includes details for each link found within the campaign.

```json
{
    "links": [
        {
            "campaignid": "1",
            "messageid": "3",
            "link": "open",
            "name": "Read Tracker",
            "ref": "",
            "tracked": "1",
            "links": {
                "campaign": "https://:account.api-us1.com/api/3/links/1/campaign",
                "message": "https://:account.api-us1.com/api/3/links/1/message"
            },
            "id": "1",
            "campaign": "1",
            "message": "3"
        },
        {
            "campaignid": "1",
            "messageid": "0",
            "link": "open",
            "name": "Read Tracker",
            "ref": "",
            "tracked": "1",
            "links": {
                "campaign": "https://:account.api-us1.com/api/3/links/2/campaign",
                "message": "https://:account.api-us1.com/api/3/links/2/message"
            },
            "id": "2",
            "campaign": "1",
            "message": null
        }
    ]
}
```

--------------------------------

### List All Deal Task Types Response Example

Source: https://developers.activecampaign.com/reference/list-all-deal-task-types

This is an example response when listing all deal task types. It shows the structure of the returned data, including task IDs, titles, and other metadata.

```json
GET /dealTasktypes (Example RESPONSE)
{
  "dealTasktypes": [
    {
      "cdate": null,
      "defduration": "0",
      "id": "1",
      "links": [],
      "status": "0",
      "title": "Call",
      "udate": null
    },
    {
      "cdate": null,
      "defduration": "0",
      "id": "2",
      "links": [],
      "status": "0",
      "title": "Email",
      "udate": null
    },
    {
      "cdate": null,
      "defduration": "0",
      "id": "3",
      "links": [],
      "status": "0",
      "title": "Lunch",
      "udate": null
    },
    {
      "cdate": null,
      "defduration": "0",
      "id": "4",
      "links": [],
      "status": "0",
      "title": "Meeting",
      "udate": null
    }
  ],
  "meta": {
    "total": "4"
  }
}
```

--------------------------------

### GET /messages/:id (Example RESPONSE)

Source: https://developers.activecampaign.com/reference/retrieve-a-message

This is an example response when retrieving a message. It contains all the details of the message, including its text and HTML content, sender information, and timestamps.

```json
{
    "message": {
        "userid": "1",
        "ed_instanceid": "1",
        "ed_version": "2",
        "cdate": "2018-08-17T13:47:32-05:00",
        "mdate": "2018-08-17T13:47:32-05:00",
        "name": "Please confirm your subscription to %LISTNAME%",
        "fromname": "John Doe",
        "fromemail": "noreply@example.com",
        "reply2": "",
        "priority": "3",
        "charset": "utf-8",
        "encoding": "8bit",
        "format": "mime",
        "subject": "Please confirm your subscription to %LISTNAME%",
        "preheader_text": "",
        "text": " \n\nThank you for subscribing to %LISTNAME%!\n\nYou or someone has subscribed to this list on %SUBDATE% using the\naddress %EMAIL%.\n\nTo confirm that you wish to be subscribed, please click the link below:\n\nConfirm My Subscription <%CONFIRMLINK%> \n\nIf you believe that this is a mistake and you did not intend on\nsubscribing to this list,\nyou can ignore this message and nothing else will happen.",
        "html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">
<html lang=\"en\" style=\"margin: 0; outline: none; padding: 0;"><head><!--[if !mso]><meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge"><!--<![endif]--><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"><meta http-equiv=\"Content-Language\" content=\"locale_contentlang\"><meta name=\"format-detection\" content=\"telephone=no\"><meta name=\"format-detection\" content=\"date=no\"><meta name=\"format-detection\" content=\"address=no\"><meta name=\"format-detection\" content=\"email=no\"><title>Preview</title><style data-ac-keep=\"true\">
.ExternalClass {width:100%; background:inherit; background-color:inherit;}
.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }
.undoreset div p, .undoreset p { margin-bottom: 20px; }
div[class^=\"aolmail_divbody\"] { overflow: auto; }
[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }
</style><style data-ac-keep=\"true\">
@media only screen and (max-width: 600px) {	/*-------------------------------------------------------------------------*\ Abandoned Cart widget \*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ td[height=\"10\"]{height:10px!important;font-size:10px!important;line-height:10px!important;}
td[height=\"13\"]{height:13px!important;font-size:13px!important;line-height:13px!important;}
td[height=\"14\"]{height:14px!important;font-size:14px!important;line-height:14px!important;}
td[height=\"12\"]{height:12px!important;font-size:12px!important;line-height:12px!important;} /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }
</style><style data-ac-keep=\"true\"> </style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\"ac-designer\" class=\"body\" style=\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #f5f5f5; width: 100%; text-ali"        }
    }
}
```

--------------------------------

### Create User Response Example

Source: https://developers.activecampaign.com/reference/create-user

This is an example of a successful response when creating a user. It includes the user's ID and links to related resources.

```json
{
    "user": {
        "username": "jdoe",
        "email": "johndoe@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "lang": "english",
        "localZoneid": "America/New_York",
        "cdate": "2022-02-02T16:01:44-06:00",
        "udate": "2022-02-02T16:01:44-06:00",
        "links": {
            "lists": "https://:account.api-us1.com/api/3/users/3/lists",
            "userGroup": "https://:account.api-us1.com/api/3/users/3/userGroup",
            "dealGroupTotals": "https://:account.api-us1.com/api/3/users/3/dealGroupTotals",
            "dealGroupUsers": "https://:account.api-us1.com/api/3/users/3/dealGroupUsers",
            "configs": "https://:account.api-us1.com/api/3/users/3/configs",
            "dealConnection": "https://:account.api-us1.com/api/3/users/3/dealConnection",
            "userConversationsPermission": "https://:account.api-us1.com/api/3/users/3/userConversationsPermission",
            "seatUser": "https://:account.api-us1.com/api/3/users/3/seatUser"
        },
        "id": "3"
    }
}
```

--------------------------------

### GET /fields/:id - Example Response

Source: https://developers.activecampaign.com/reference/retrieve-a-custom-field-contact

This is an example of the JSON response you will receive when successfully retrieving a custom field by its ID. It includes details about the field's properties, options, and relations.

```json
{
    "fieldOptions": [],
    "fieldRels": [
        {
            "field": "1",
            "relid": "0",
            "dorder": "0",
            "cdate": "2018-08-17T11:09:43-05:00",
            "links": [],
            "id": "1"
        }
    ],
    "field": {
        "title": "test",
        "descript": "",
        "type": "text",
        "isrequired": "0",
        "perstag": "TEST",
        "defval": "",
        "show_in_list": "0",
        "rows": "0",
        "cols": "0",
        "visible": "1",
        "service": "",
        "ordernum": "1",
        "cdate": "2018-08-17T11:09:43-05:00",
        "udate": "2018-08-17T11:09:43-05:00",
        "options": [],
        "relations": [
            "1"
        ],
        "links": {
            "options": "https://:account.api-us1.com/api/3/fields/1/options",
            "relations": "https://:account.api-us1.com/api/3/fields/1/relations"
        },
        "id": "1"
    }
}
```

--------------------------------

### GET /savedResponses/:id Example Response

Source: https://developers.activecampaign.com/reference/get-a-savedresponse

This is an example of the JSON response you will receive when retrieving a saved response by its ID. It includes details like title, subject, body, and creation/modification dates.

```json
GET /savedResponses/:id (Example RESPONSE)
{
    "savedResponse": {
        "title": "Response title",
        "subject": "Response subject",
        "body": "Response body",
        "ldate": null,
        "last_sent_user_id": null,
        "cdate": "2018-11-16T02:50:54-06:00",
        "mdate": null,
        "links": {
            "user": "https://:account.api-us1.com/api/:version/savedResponses/1/user",
            "savedResponseCategorySavedResponse": "https://:account.api-us1.com/api/:version/savedResponses/1/savedResponseCategorySavedResponse"
        },
        "id": "1"
    }
}
```

--------------------------------

### List All Accounts Response Example

Source: https://developers.activecampaign.com/reference/list-all-accounts

This is an example of the JSON response you will receive when listing all accounts. It includes account details such as name, creation timestamp, and associated links.

```json
GET /accounts (Example RESPONSE)
{
    "accounts": [
        {
            "name": "First Example Account",
            "accountUrl": null,
            "createdTimestamp": "2019-04-29T07:51:31-05:00",
            "updatedTimestamp": "2019-04-29T07:51:31-05:00",
            "contactCount": "1",
            "dealCount": "3",
            "links": [
                "notes": "https://:account.api-us1.com/api/:version/accounts/1/notes",
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accounts/1/accountCustomFieldData",
                "accountContacts": "https://:account.api-us1.com/api/:version/accounts/1/accountContacts"],
            "id": "1"
        },
        {
            "name": "Second Example Account",
            "accountUrl": null,
            "createdTimestamp": "2019-04-29T07:51:32-05:00",
            "updatedTimestamp": "2019-04-29T07:51:32-05:00",
            "contactCount": "2",
            "dealCount": "5",
            "links": [
                "notes": "https://:account.api-us1.com/api/:version/accounts/2/notes",
                "accountCustomFieldData": "https://:account.api-us1.com/api/:version/accounts/2/accountCustomFieldData",
                "accountContacts": "https://:account.api-us1.com/api/:version/accounts/2/accountContacts"],
            "id": "2"
        }
    ],
    "meta": {
      "total": "2"
    }
}
```

--------------------------------

### List Webhook Events Response

Source: https://developers.activecampaign.com/reference/get-a-list-of-webhook-events

This is an example response for the GET /webhook/events endpoint, showing the structure of the returned data.

```json
{
  "webhookEvents": [
    "bounce",
    "click",
    "contact_tag_added",
    "contact_tag_removed",
    "deal_add",
    "deal_note_add",
    "deal_pipeline_add",
    "deal_stage_add",
    "deal_task_add",
    "deal_task_complete",
    "deal_tasktype_add",
    "deal_update",
    "forward",
    "list_add",
    "open",
    "reply",
    "sent",
    "share",
    "sms_reply",
    "sms_sent",
    "sms_unsub",
    "subscribe",
    "subscriber_note",
    "unsubscribe",
    "update"
  ],
  "meta": {
    "total": 25
  }
}
```

--------------------------------

### Create Schema with Deal Relationship

Source: https://developers.activecampaign.com/reference/create-a-schema

This example shows how to create a schema that relates to deals. Set the 'namespace' to 'deals' to establish this connection.

```json
{
	"schema": {
		"slug": "my-object",
		"labels": {
			"singular": "My Object",
			"plural": "My Objects"
		},
		"description": "Sample Schema",
		"fields": [{
			"id": "my-number-field",
			"labels": {
				"singular": "Number",
				"plural": "Numbers"
			},
			"type": "number",
			"required": false,
			"scale": 0
		}],
		"relationships": [{
			"id": "deal",
			"labels": {
				"singular": "Deal",
				"plural": "Deals"
			},
			"description": "Deals related to this object",
			"namespace": "deals",
			"hasMany": false
		}]

	}
}
```

--------------------------------

### List All Event Types Response

Source: https://developers.activecampaign.com/reference/list-all-event-types

This is an example response from the GET /eventTrackingEvents endpoint, showing the structure of the returned event names.

```json
GET /eventTrackingEvents (Example RESPONSE)
{
  "eventTrackingEvents": [
    {
      "name": "__pagevisit"
    },
    {
      "name": "__redir"
    }
  ],
  "meta": {
    "total": 2,
  }
}
```

--------------------------------

### List All Webhooks Response Example

Source: https://developers.activecampaign.com/reference/get-a-list-of-webhooks

This is an example of the JSON response when listing all webhooks. It includes details like creation date, list ID, name, URL, and associated events.

```json
{
  "webhooks": [
    {
      "cdate": "2016-01-01T12:00:00-00:00",
      "listid": "0",
      "name": "My Hook",
      "url": "http://example.com/my-hook",
      "events": [
        "subscribe",
        "unsubscribe",
        "sent"
      ],
      "sources": [
        "public",
        "system"
      ],
      "links": [],
      "id": "1"
    },
    {
      "cdate": "2016-01-01T12:00:00-00:00",
      "listid": "0",
      "name": "My Hook 2",
      "url": "http://example.com/my-hook-2",
      "events": [
        "subscribe"
      ],
      "sources": [
        "admin"
      ],
      "links": [],
      "id": "2"
    },
  ],
  "meta": {
    "total": "2"
  }
}
```

--------------------------------

### Group Creation Response Example

Source: https://developers.activecampaign.com/reference/create-a-new-group

This example shows the structure of a successful response when creating or retrieving a group. It includes the group's ID, title, administrative privileges, and links to related resources.

```json
{
    "group": {
        "title": "My Groups Title",
        "p_admin": 1,
        "links": {
            "userGroups": "https://:account.api-us1.com/api/:version/groups/7/userGroups",
            "groupLimit": "https://:account.api-us1.com/api/:version/groups/7/groupLimit",
            "dealGroupGroups": "https://:account.api-us1.com/api/:version/groups/7/dealGroupGroups",
            "listGroups": "https://:account.api-us1.com/api/:version/groups/7/listGroups",
            "addressGroups": "https://:account.api-us1.com/api/:version/groups/7/addressGroups",
            "automationGroups": "https://:account.api-us1.com/api/:version/groups/7/automationGroups"
        },
        "id": "7"
    }
}
```

--------------------------------

### Example Response for Get Record by ID

Source: https://developers.activecampaign.com/reference/get-a-single-record

This is an example of the JSON response received when successfully retrieving a custom object record by its ID. It includes details such as the record's ID, external ID, schema ID, fields, relationships, and timestamps.

```json
{
  "record": {
    "id": "1fba439a-208e-48e6-bd23-f6c97c3e0519",
    "externalId": "test-obj-1",
    "schemaId": "6449c3f3-b68d-46d1-850b-c8aea998ce1b",
    "fields": [
      {
        "id": "my-number-field",
        "value": 100
      }
    ],
    "relationships": {
      "primary-contact": [
        "14"
      ]
    },
    "createdTimestamp": "2021-04-16T16:12:22.222685095Z",
    "updatedTimestamp": "2021-04-16T16:13:12.022671090Z"
  }
}
```

--------------------------------

### Bulk Update Deal Owners Success Response Example

Source: https://developers.activecampaign.com/reference/bulk-update-deal-owners

Example of a successful response from the bulk update deal owners endpoint, detailing which deals were updated successfully, which remained unchanged, and which failed.

```json
{
    "success": [
        "1",
        "2"
    ],
    "nochange": [
        "3"
    ],
    "failed": []
}
```

--------------------------------

### Retrieve Event Tracking Status Response

Source: https://developers.activecampaign.com/reference/retrieve-event-tracking-status

This is an example response from the GET /eventTracking endpoint, indicating whether event tracking is enabled.

```json
{
  "eventTracking" {
    "enabled": true
  }
}
```

--------------------------------

### Deal Update Response Example

Source: https://developers.activecampaign.com/reference/update-a-deal-new

This is an example of a successful response when updating a deal. It returns the updated deal object along with links to related resources.

```json
{
  "contacts": [
    {
      "adate": "2017-02-06 15:50:11",
      "bounced_date": "0000-00-00",
      "bounced_hard": "0",
      "bounced_soft": "0",
      "cdate": "2017-02-03T11:26:41-06:00",
      "deleted": "0",
      "edate": "0000-00-00 00:00:00",
      "email": "johndoe@example.com",
      "email_domain": "",
      "email_local": "",
      "firstName": "",
      "gravatar": "1",
      "hash": "e1705a92f24edf5313ed21df44d6ff5f",
      "id": "51",
      "ip": "0",
      "lastName": "",
      "links": {
        "bounceLogs": "/api/3/contacts/51/bounceLogs",
        "contactAutomations": "/api/3/contacts/51/contactAutomations",
        "contactData": "/api/3/contacts/51/contactData",
        "contactDeals": "/api/3/contacts/51/contactDeals",
        "contactGoals": "/api/3/contacts/51/contactGoals",
        "contactLists": "/api/3/contacts/51/contactLists",
        "contactLogs": "/api/3/contacts/51/contactLogs",
        "contactTags": "/api/3/contacts/51/contactTags",
        "deals": "/api/3/contacts/51/deals",
        "fieldValues": "/api/3/contacts/51/fieldValues",
        "geoIps": "/api/3/contacts/51/geoIps",
        "notes": "/api/3/contacts/51/notes",
        "organization": "/api/3/contacts/51/organization",
        "plusAppend": "/api/3/contacts/51/plusAppend",
        "scoreValues": "/api/3/contacts/51/scoreValues",
        "trackingLogs": "/api/3/contacts/51/trackingLogs"
      },
      "organization": null,
      "orgid": "0",
      "phone": "",
      "rating_tstamp": "0000-00-00",
      "segmentio_id": "",
      "sentcnt": "0",
      "socialdata_lastcheck": "0000-00-00 00:00:00",
      "ua": "",
      "udate": "2017-02-03T11:26:41-06:00"
    }
  ],
    "deal": {
        "description": "This deal is an important deal",
        "currency": "usd",
        "percent": null,
        "status": 0,
        "title": "AC Deal",
        "value": 45600,
        "organization": 45,
        "contact": 1,
        "group": "1",
        "owner": "1",
        "stage": "1",
        "cdate": "2019-12-09T12:29:33-06:00",
        "mdate": "2019-12-09T12:29:33-06:00",
        "nextdate": null,
        "hash": "c3a5497c",
        "winProbability": null,
        "winProbabilityMdate": null,
        "links": {
            "dealActivities": "/api/3/deals/51/dealActivities",
            "contact": "/api/3/deals/51/contact",
            "contactDeals": "/api/3/deals/51/contactDeals",
            "group": "/api/3/deals/51/group",
            "nextTask": "/api/3/deals/51/nextTask",
            "notes": "/api/3/deals/51/notes",
            "account": "/api/3/deals/51/account",
            "customerAccount": "/api/3/deals/51/customerAccount",
            "organization": "/api/3/deals/51/organization",
            "owner": "/api/3/deals/51/owner",
            "scoreValues": "/api/3/deals/51/scoreValues",
            "stage": "/api/3/deals/51/stage",
            "tasks": "/api/3/deals/51/tasks",
            "dealCustomFieldData": "/api/3/deals/51/dealCustomFieldData"
        },
        "fields": [
            {
                "customFieldId": 1,
                "fieldValue": "First field value"
            }
        ]
    }
}
```

--------------------------------

### List All Segments API Response

Source: https://developers.activecampaign.com/reference/list-all-segments

This is an example response from the GET /segments endpoint, showing the structure of segment data returned by the API.

```json
{
    "segments": [
        {
            "name": "Segment of Automation 1",
            "logic": "and",
            "hidden": "0",
            "seriesid": "1",
            "links": [],
            "id": "1"
        },
        {
            "name": "Segment of Email Subscription",
            "logic": "and",
            "hidden": "0",
            "seriesid": "1",
            "links": [],
            "id": "2"
        },
        {
            "name": "Segment of daasf",
            "logic": "and",
            "hidden": "0",
            "seriesid": "0",
            "links": [],
            "id": "3"
        },
        {
            "name": "Segment of Automation 2",
            "logic": "and",
            "hidden": "0",
            "seriesid": "2",
            "links": [],
            "id": "4"
        }
    ],
    "meta": {
        "total": "4"
    }
}
```