Documentation Index

Fetch the complete documentation index at: https://support.jacquard.com/llms.txt

Use this file to discover all available pages before exploring further.

Get account information

Prev Next
Get
/v2/accounts/{accountid}

Retrieves the details of an account if the supplied access token is valid and associated with the requested account it will return information. If the token is invalid or not associated with the account it will return an error. Only superhero users can access this endpoint.

Security
HTTP
Type bearer
Header parameters
Accept
string
Exampleapplication/json
Path parameters
accountid
stringRequired

(Required) Account ID

Examplead Ut
Query parameters
allChildren
boolean

Includes all users projects campaigns and language variants along with the account information

Examplefalse
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
{
  "account_id": "58fde5f99cad0a03e578fe0b",
  "name": "Wayne Enterprises",
  "created_date_time": "2016-03-15T06:08:27.928Z",
  "users": [
    {
      "user_id": "5a4b8b9a0460151a5961504a",
      "account_id": "58fde5f99cad0a03e578fe0b",
      "first_name": "Bruce",
      "last_name": "Wayne",
      "email": "bruce@wayneenterprises.com",
      "user_type": "hero",
      "assigned_projects": [
        "58fde5f99cad0a03e578fe0b",
        "58fde5f99cad0a03e578fe0b"
      ],
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "last_login_at": "2016-03-15T06:08:27.928Z"
    },
    {
      "user_id": "5a4b8b9a0460151a5961504a",
      "account_id": "58fde5f99cad0a03e578fe0b",
      "first_name": "Bruce",
      "last_name": "Wayne",
      "email": "bruce@wayneenterprises.com",
      "user_type": "hero",
      "assigned_projects": [
        "58fde5f99cad0a03e578fe0b",
        "58fde5f99cad0a03e578fe0b"
      ],
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "last_login_at": "2016-03-15T06:08:27.928Z"
    }
  ],
  "projects": [
    {
      "project_id": "58fde6419cad0a03e578fe0c",
      "account_id": "58fde5f99cad0a03e578fe0b",
      "name": "Batmobiles",
      "project_type": "email",
      "iso_language": "en-GB",
      "iso_currency": "GBP",
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "avg_conversion_rate": 3.55,
      "avg_order_value": 9.99,
      "estimated_campaigns_per_month": 2.5,
      "campaigns": [
        {
          "campaign_id": "59807ed854b8891947e04303",
          "project_id": "58fde6419cad0a03e578fe0c",
          "name": "Batmobiles Daily Deals",
          "distribution_channel": "email/push/facebook/sms",
          "testing_methodology": "broadcast/convergence",
          "language_source": "NLG/managed",
          "tracked_metrics": [
            "delivered/opened/clicked",
            "delivered/opened/clicked"
          ],
          "baseline_open_rate": 1.23,
          "created_date_time": "2016-03-15T06:08:27.928Z",
          "last_updated": "2016-03-15T06:08:27.928Z",
          "test_send_date": "2016-03-15",
          "final_send_date": "2016-03-15",
          "audience_size": 12300332,
          "number_of_splits": 10,
          "split_size": 123000,
          "number_of_recipients": 10000000,
          "final_number_of_unsubs": 452,
          "final_unsub_rate": 55.5,
          "final_unique_opens": 56,
          "final_unique_open_rate": 8.41,
          "final_unique_clicks": 55,
          "final_unique_click_rate": 8.26,
          "final_revenue": 5568.21,
          "final_number_of_conversions": 302,
          "variants": [
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            },
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            }
          ]
        },
        {
          "campaign_id": "59807ed854b8891947e04303",
          "project_id": "58fde6419cad0a03e578fe0c",
          "name": "Batmobiles Daily Deals",
          "distribution_channel": "email/push/facebook/sms",
          "testing_methodology": "broadcast/convergence",
          "language_source": "NLG/managed",
          "tracked_metrics": [
            "delivered/opened/clicked",
            "delivered/opened/clicked"
          ],
          "baseline_open_rate": 1.23,
          "created_date_time": "2016-03-15T06:08:27.928Z",
          "last_updated": "2016-03-15T06:08:27.928Z",
          "test_send_date": "2016-03-15",
          "final_send_date": "2016-03-15",
          "audience_size": 12300332,
          "number_of_splits": 10,
          "split_size": 123000,
          "number_of_recipients": 10000000,
          "final_number_of_unsubs": 452,
          "final_unsub_rate": 55.5,
          "final_unique_opens": 56,
          "final_unique_open_rate": 8.41,
          "final_unique_clicks": 55,
          "final_unique_click_rate": 8.26,
          "final_revenue": 5568.21,
          "final_number_of_conversions": 302,
          "variants": [
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            },
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            }
          ]
        }
      ]
    },
    {
      "project_id": "58fde6419cad0a03e578fe0c",
      "account_id": "58fde5f99cad0a03e578fe0b",
      "name": "Batmobiles",
      "project_type": "email",
      "iso_language": "en-GB",
      "iso_currency": "GBP",
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "avg_conversion_rate": 3.55,
      "avg_order_value": 9.99,
      "estimated_campaigns_per_month": 2.5,
      "campaigns": [
        {
          "campaign_id": "59807ed854b8891947e04303",
          "project_id": "58fde6419cad0a03e578fe0c",
          "name": "Batmobiles Daily Deals",
          "distribution_channel": "email/push/facebook/sms",
          "testing_methodology": "broadcast/convergence",
          "language_source": "NLG/managed",
          "tracked_metrics": [
            "delivered/opened/clicked",
            "delivered/opened/clicked"
          ],
          "baseline_open_rate": 1.23,
          "created_date_time": "2016-03-15T06:08:27.928Z",
          "last_updated": "2016-03-15T06:08:27.928Z",
          "test_send_date": "2016-03-15",
          "final_send_date": "2016-03-15",
          "audience_size": 12300332,
          "number_of_splits": 10,
          "split_size": 123000,
          "number_of_recipients": 10000000,
          "final_number_of_unsubs": 452,
          "final_unsub_rate": 55.5,
          "final_unique_opens": 56,
          "final_unique_open_rate": 8.41,
          "final_unique_clicks": 55,
          "final_unique_click_rate": 8.26,
          "final_revenue": 5568.21,
          "final_number_of_conversions": 302,
          "variants": [
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            },
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            }
          ]
        },
        {
          "campaign_id": "59807ed854b8891947e04303",
          "project_id": "58fde6419cad0a03e578fe0c",
          "name": "Batmobiles Daily Deals",
          "distribution_channel": "email/push/facebook/sms",
          "testing_methodology": "broadcast/convergence",
          "language_source": "NLG/managed",
          "tracked_metrics": [
            "delivered/opened/clicked",
            "delivered/opened/clicked"
          ],
          "baseline_open_rate": 1.23,
          "created_date_time": "2016-03-15T06:08:27.928Z",
          "last_updated": "2016-03-15T06:08:27.928Z",
          "test_send_date": "2016-03-15",
          "final_send_date": "2016-03-15",
          "audience_size": 12300332,
          "number_of_splits": 10,
          "split_size": 123000,
          "number_of_recipients": 10000000,
          "final_number_of_unsubs": 452,
          "final_unsub_rate": 55.5,
          "final_unique_opens": 56,
          "final_unique_open_rate": 8.41,
          "final_unique_clicks": 55,
          "final_unique_click_rate": 8.26,
          "final_revenue": 5568.21,
          "final_number_of_conversions": 302,
          "variants": [
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            },
            {
              "language_variant_id": "5c07e39e477ca9289615b441",
              "campaign_id": "59807ed854b8891947e04303",
              "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
              "project_id": "59807ed854b8891947e04303",
              "created_date_time": "2016-03-15T06:08:27.928Z",
              "last_updated": "2016-03-15T06:08:27.928Z",
              "variant_sent_time": "2016-03-15T06:08:27.928Z",
              "results_at": "2016-03-15T06:08:27.928Z",
              "is_user_language_variant": false,
              "number_of_recipients": 666,
              "number_of_unsubs": 452,
              "unsub_rate": 55,
              "unique_opens": 56,
              "unique_open_rate": 8.41,
              "unique_clicks": 55,
              "unique_click_rate": 8.26,
              "is_winning_line": false,
              "status": "live"
            }
          ]
        }
      ]
    }
  ]
}
object
401

Unauthorized

""
string
403

Forbidden

""
string