Who is asking, what is set up, and what is next

Shows the Ziplined account: the workspace, the plan and its limits, the credits left, and what is set up. It returns the user behind this call, the plan, the credit balance, the ideal client and the audiences. It also returns the sources by how their last run went, and the views, syncs and destinations that fail. Last, it returns the one next step: a tool to call or a page in the app, with its cost. It is not a required first step: the other tools take names and work on their own. Use when: The user asks which workspace they are in, how many credits are left, or what their plan allows. Also what is set up or broken, or what to do next in Ziplined. Do not use for: Questions about people, posts, companies, views or results (use search_people, list_posts, search_companies, list_views or get_insights instead). The full rows of one kind (use list_sources, list_views or list_destinations instead). Anything Ziplined cannot do: writing posts or emails, or sending LinkedIn connection requests or messages. Example: {"detail":"full"}

GET

account

curl --request GET \
  --url https://api.ziplined.io/v1/account \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ziplined.io/v1/account', 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.ziplined.io/v1/account",
  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.ziplined.io/v1/account"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/account")

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

{
  "account": {
    "user": {
      "type": "member",
      "id": "<string>"
    },
    "workspace": {
      "id": "<string>",
      "name": "<string>"
    },
    "plan": {
      "code": "<string>",
      "data": true
    },
    "credits": {
      "runs_on_credits": true,
      "balance": 123,
      "spent_this_period": 123,
      "credits_used": {
        "posts": 123,
        "engagements": 123,
        "relationships": 123,
        "contacts": 123
      },
      "leads_this_period": 123,
      "resets_at": "<string>"
    },
    "icp": {
      "is_set": true,
      "sentence": "<string>"
    },
    "setup": {
      "website": true,
      "linkedin_profile": true,
      "team": true
    },
    "audiences": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "sources": {
      "active": 123,
      "paused": 123,
      "last_run": {
        "queued": 123,
        "running": 123,
        "succeeded": 123,
        "failed": 123,
        "blocked_no_credits": 123,
        "none": 123
      }
    },
    "views": {
      "count": 123,
      "with_failed_sync": 123
    },
    "syncs": {
      "count": 123,
      "paused": 123,
      "failed": 123
    },
    "destinations": {
      "count": 123,
      "connected": 123,
      "paused": 123,
      "failed": 123
    },
    "next_step": {
      "kind": "<string>",
      "reason": "<string>",
      "cost": "<string>",
      "tool": "<string>",
      "url": "<string>"
    },
    "lists": {
      "sources": [
        {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>",
          "last_run": "queued"
        }
      ],
      "views": [
        {
          "id": "<string>",
          "name": "<string>",
          "syncs": 123,
          "failed_syncs": 123
        }
      ],
      "syncs": [
        {
          "id": "<string>",
          "view_id": "<string>",
          "view_name": "<string>",
          "destination_id": "<string>",
          "provider": "<string>",
          "status": "active"
        }
      ],
      "destinations": [
        {
          "id": "<string>",
          "provider": "<string>",
          "name": "<string>",
          "status": "connected"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

detail

enum<string>

default:short

full adds the rows behind the counts under lists.

Available options:

short,

full

Response

The result

account

object

required

Show child attributes

Who is asking, what is set up, and what is next

curl --request GET \
  --url https://api.ziplined.io/v1/account \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ziplined.io/v1/account', 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.ziplined.io/v1/account",
  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.ziplined.io/v1/account"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/account")

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

{
  "account": {
    "user": {
      "type": "member",
      "id": "<string>"
    },
    "workspace": {
      "id": "<string>",
      "name": "<string>"
    },
    "plan": {
      "code": "<string>",
      "data": true
    },
    "credits": {
      "runs_on_credits": true,
      "balance": 123,
      "spent_this_period": 123,
      "credits_used": {
        "posts": 123,
        "engagements": 123,
        "relationships": 123,
        "contacts": 123
      },
      "leads_this_period": 123,
      "resets_at": "<string>"
    },
    "icp": {
      "is_set": true,
      "sentence": "<string>"
    },
    "setup": {
      "website": true,
      "linkedin_profile": true,
      "team": true
    },
    "audiences": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "sources": {
      "active": 123,
      "paused": 123,
      "last_run": {
        "queued": 123,
        "running": 123,
        "succeeded": 123,
        "failed": 123,
        "blocked_no_credits": 123,
        "none": 123
      }
    },
    "views": {
      "count": 123,
      "with_failed_sync": 123
    },
    "syncs": {
      "count": 123,
      "paused": 123,
      "failed": 123
    },
    "destinations": {
      "count": 123,
      "connected": 123,
      "paused": 123,
      "failed": 123
    },
    "next_step": {
      "kind": "<string>",
      "reason": "<string>",
      "cost": "<string>",
      "tool": "<string>",
      "url": "<string>"
    },
    "lists": {
      "sources": [
        {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>",
          "last_run": "queued"
        }
      ],
      "views": [
        {
          "id": "<string>",
          "name": "<string>",
          "syncs": 123,
          "failed_syncs": 123
        }
      ],
      "syncs": [
        {
          "id": "<string>",
          "view_id": "<string>",
          "view_name": "<string>",
          "destination_id": "<string>",
          "provider": "<string>",
          "status": "active"
        }
      ],
      "destinations": [
        {
          "id": "<string>",
          "provider": "<string>",
          "name": "<string>",
          "status": "connected"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

People

Companies

Posts

Engagements

Insights

Views

Audiences

ICP

Sources

Account

Credits

Integrations

Who is asking, what is set up, and what is next

Authorizations

Query Parameters

Response