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

# Introduction

> Automate your WhatsApp with Periskope APIs

Welcome to the Periskope API documentation. Periskope APIs lets you extend the capabilities of WhatsApp and automate actions on your WhatsApp account and the Periskope platform.

The Periskope API is designed based on REST principles has predictable, responsibly named URLs and returns simple JSON objects. Our APIs ensure straightforward and effective communication with your Periskope account, offering capabilities such as sending messages, raising tickets, creating groups etc.

We encourage responsible usage of the APIs. Follow these best practices and recommendations for safe actions on WhatsApp - [https://docs.periskope.app/get-started/best-practices](https://docs.periskope.app/get-started/best-practices)

## Prerequisites

1. **Sign up for a free account on Periskope**: To use the Periskope API, you need to have an active Periskope account. If you don’t have one, you can sign up for a 7-day free trial here.
2. **Scan the QR code from WhatsApp to connect your phone**: A connected phone is required to use the APIs
3. **Generate an API Key**: An API key is required for authentication and can be generated from your Periskope settings [here](https://console.periskope.app/settings/integrations/api).

## Setting up APIs on Postman [🔗](https://www.postman.com/periskope/workspace/periskope-platform-api)

<Steps>
  <Step title="Search for Periskope API Collection (Postman)">
    To begin, search for the `Periskope Platform API` collection on Postman or
    click here to
    [open](https://www.postman.com/periskope/workspace/periskope-platform-api).
    This collection contains all the requests you need to work with our API.

    <Frame caption="Search Periskope Platform API">
      <img className="border rounded-xl" src="https://mintcdn.com/bharatkumarramesh/nLZLyDfnObVs3JXO/api-reference/assets/search.png?fit=max&auto=format&n=nLZLyDfnObVs3JXO&q=85&s=938c94735867bebfd2df2dea03b76d9c" alt="Step 1" width="2047" height="1279" data-path="api-reference/assets/search.png" />
    </Frame>
  </Step>

  <Step title="Create a fork">
    * To fork the collection, right click on the collection.
    * Click on the `Create a Fork` button in the menu.
    * Now you can choose `name` of the collection and the `workspace` you want to add it to.
    * This will fork the collection into `your workspace`

    <Frame caption="Create a fork">
      <img className="border rounded-xl h-96 w-auto" src="https://mintcdn.com/bharatkumarramesh/nLZLyDfnObVs3JXO/api-reference/assets/create-fork.png?fit=max&auto=format&n=nLZLyDfnObVs3JXO&q=85&s=d9ab069b26437678b09e31a363000d50" alt="Step 1" width="616" height="883" data-path="api-reference/assets/create-fork.png" />
    </Frame>
  </Step>

  <Step title="Add headers">
    <Tip>
      For `Postman` users, we've made setting up testing for Periskope APIs on `Postman` easy for you.
      You don't need to pass `x-phone` or `authorization` header with each request.

      Just need to update `orgPhone` and `apiKey` in the collection variables in order to automatically pass the headers into each request.

      In case, you're using any other tools for testing APIs, you'll need to pass the headers manually for each request.
    </Tip>

    #### If you're using Postman, follow the steps given below -

    <Steps>
      <Step title="Update collection variables">
        * You need to add `apiKey` and `orgPhone` variables in the collection. You can do this by clicking on the collection and then clicking on the `Variables` tab.
        * In the `Variables` tab, update the value of the `apiKey` you generated in the previous step.
        * You also need to update the value of `orgPhone` with your phone number (with country code and without any special characters) to validate an API request. For e.g. `919876512340`.
      </Step>

      <Step title="Done ✅">
        That's it! Now you can start testing the Periskope APIs from your Postman collection.
      </Step>
    </Steps>

    <Frame caption="Update collection variables">
      <img className="border rounded-xl h-96 w-auto" src="https://mintcdn.com/bharatkumarramesh/nLZLyDfnObVs3JXO/api-reference/assets/update-variables.png?fit=max&auto=format&n=nLZLyDfnObVs3JXO&q=85&s=f87702aae9956a0499b8719989e2654f" alt="Step 1" width="2025" height="1252" data-path="api-reference/assets/update-variables.png" />
    </Frame>
  </Step>
</Steps>