> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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"}



## OpenAPI

````yaml /openapi.json get /v1/account
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Views
    description: The saved views of the app, and who is in a hand-picked one.
  - name: Audiences
    description: The scored target groups, and their membership.
  - name: ICP
    description: 'Who you sell to: the rules every person is scored against.'
  - name: Sources
    description: What your radar collects from.
  - name: Account
    description: Who is asking, what is set up, and what is next.
  - name: Credits
    description: What is left to spend on sources, and when it resets.
  - name: Integrations
    description: 'Where syncs send people: webhook, email, Slack and app destinations.'
paths:
  /v1/account:
    get:
      tags:
        - Account
      summary: Who is asking, what is set up, and what is next
      description: >-
        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"}
      parameters:
        - schema:
            type: string
            enum:
              - short
              - full
            default: short
            description: full adds the rows behind the counts under lists.
          required: false
          description: full adds the rows behind the counts under lists.
          name: detail
          in: query
      responses:
        '200':
          description: The result
          content:
            application/json:
              schema:
                type: object
                properties:
                  account:
                    type: object
                    properties:
                      user:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - member
                              - api_key
                              - system
                          id:
                            type: string
                        required:
                          - type
                          - id
                      workspace:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                            nullable: true
                        required:
                          - id
                          - name
                      plan:
                        type: object
                        properties:
                          code:
                            type: string
                            nullable: true
                            description: Null when there is no plan.
                          data:
                            type: boolean
                            description: >-
                              True when the plan includes the data product:
                              sources, people, syncs.
                        required:
                          - code
                          - data
                      credits:
                        type: object
                        properties:
                          runs_on_credits:
                            type: boolean
                            description: False when this workspace does not spend credits.
                          balance:
                            type: number
                            nullable: true
                          spent_this_period:
                            type: number
                            nullable: true
                          credits_used:
                            type: object
                            nullable: true
                            properties:
                              posts:
                                type: number
                                description: Credits for posts.
                              engagements:
                                type: number
                                description: Credits for reactions and comments.
                              relationships:
                                type: number
                                description: Credits for profile visits and followers.
                              contacts:
                                type: number
                                description: Credits for email and phone lookups.
                            required:
                              - posts
                              - engagements
                              - relationships
                              - contacts
                            description: >-
                              Credits used this period, per kind. Ziplined
                              charges credits per item, once, when the item
                              first shows up for this workspace. An item costs 1
                              per post, 1 per reaction or comment, and 1 per
                              profile visit or follower. Contact lookups on a
                              sync cost 5 credits per verified email and 25 per
                              phone number.
                          leads_this_period:
                            type: number
                            nullable: true
                            description: >-
                              Leads found this period: people who fit and first
                              reacted on or after the first day of the credit
                              period.
                          resets_at:
                            type: string
                            nullable: true
                        required:
                          - runs_on_credits
                          - balance
                          - spent_this_period
                          - credits_used
                          - leads_this_period
                          - resets_at
                      icp:
                        type: object
                        properties:
                          is_set:
                            type: boolean
                          sentence:
                            type: string
                            nullable: true
                        required:
                          - is_set
                          - sentence
                      setup:
                        type: object
                        properties:
                          website:
                            type: boolean
                          linkedin_profile:
                            type: boolean
                          team:
                            type: boolean
                        required:
                          - website
                          - linkedin_profile
                          - team
                        description: The steps done in the app only.
                      audiences:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - name
                        description: For search_people and refresh_data.
                      sources:
                        type: object
                        properties:
                          active:
                            type: integer
                          paused:
                            type: integer
                          last_run:
                            type: object
                            properties:
                              queued:
                                type: integer
                              running:
                                type: integer
                              succeeded:
                                type: integer
                              failed:
                                type: integer
                              blocked_no_credits:
                                type: integer
                              none:
                                type: integer
                            required:
                              - queued
                              - running
                              - succeeded
                              - failed
                              - blocked_no_credits
                              - none
                            description: >-
                              Sources per status of their last run.
                              blocked_no_credits is its own status, never
                              counted as failed.
                        required:
                          - active
                          - paused
                          - last_run
                      views:
                        type: object
                        properties:
                          count:
                            type: integer
                          with_failed_sync:
                            type: integer
                        required:
                          - count
                          - with_failed_sync
                      syncs:
                        type: object
                        properties:
                          count:
                            type: integer
                          paused:
                            type: integer
                          failed:
                            type: integer
                        required:
                          - count
                          - paused
                          - failed
                      destinations:
                        type: object
                        properties:
                          count:
                            type: integer
                          connected:
                            type: integer
                          paused:
                            type: integer
                          failed:
                            type: integer
                        required:
                          - count
                          - connected
                          - paused
                          - failed
                      next_step:
                        type: object
                        properties:
                          kind:
                            type: string
                            description: >-
                              tool: call `tool`. Otherwise a page in the app at
                              `url`.
                          tool:
                            type: string
                          url:
                            type: string
                          reason:
                            type: string
                          cost:
                            type: string
                            nullable: true
                            description: >-
                              What this step costs in credits, or null when it
                              costs nothing.
                        required:
                          - kind
                          - reason
                          - cost
                      lists:
                        type: object
                        properties:
                          sources:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                status:
                                  type: string
                                last_run:
                                  type: string
                                  nullable: true
                                  enum:
                                    - queued
                                    - running
                                    - succeeded
                                    - failed
                                    - blocked_no_credits
                                    - null
                              required:
                                - id
                                - name
                                - status
                                - last_run
                          views:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                syncs:
                                  type: integer
                                failed_syncs:
                                  type: integer
                              required:
                                - id
                                - name
                                - syncs
                                - failed_syncs
                          syncs:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                view_id:
                                  type: string
                                  nullable: true
                                  description: >-
                                    Null for the sync of all leads, without a
                                    view.
                                view_name:
                                  type: string
                                  nullable: true
                                destination_id:
                                  type: string
                                provider:
                                  type: string
                                status:
                                  type: string
                                  enum:
                                    - active
                                    - paused
                                    - failed
                                  description: >-
                                    From the stored state. active: it sends.
                                    paused: somebody paused the sync or its
                                    destination. failed: the destination reports
                                    an error, so the sync sends nothing.
                              required:
                                - id
                                - view_id
                                - view_name
                                - destination_id
                                - provider
                                - status
                          destinations:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                provider:
                                  type: string
                                name:
                                  type: string
                                  nullable: true
                                status:
                                  type: string
                                  enum:
                                    - connected
                                    - paused
                                    - failed
                                    - disconnected
                              required:
                                - id
                                - provider
                                - name
                                - status
                        required:
                          - sources
                          - views
                          - syncs
                          - destinations
                        description: 'The rows behind the counts, only with detail: ''full''.'
                    required:
                      - user
                      - workspace
                      - plan
                      - credits
                      - icp
                      - setup
                      - audiences
                      - sources
                      - views
                      - syncs
                      - destinations
                      - next_step
                required:
                  - account
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.