---
title: "Public API"
description: "The Public API is the application interface that lets you use Netsipp programmatically from your own software."
section: "Organization"
site: "Netsipp Knowledge Base"
language: en
url: https://docs.netsipp.com/en/organizasyon/public-api
---

# **Public API**

The **Public API** is the application interface that lets you use Netsipp programmatically from your own software. Create an API user and send your requests with the key you receive to manage your accounts, contacts, calls and reports from outside.

## **Creating an API User**

- Open the **Organization Settings** screen from the left menu and switch to the **API Users** tab.
- Click the **Add API User** button.
- Enter a **name**; you can optionally set an **expiry date** and choose whether the user is **active**.
- When you save, an **API Key** is generated for you.

***Note:** The API Key is shown only once, at the moment it is created. Take it with **Copy** and store it somewhere safe; it cannot be displayed again, and if you lose it you have to create a new user.*

## **Sending Requests**

- Send your requests to **https://api.netsipp.com**.
- Carry your identity in the **Authorization** header on every request: **Authorization: Bearer <API Key>**
- To verify your connection, use the **GET https://api.netsipp.com/v1/me** call; this endpoint returns which API user the key belongs to.

***Tip:** With the test tool on the API Users tab you can try the **/v1/me** call right after saving your key and see that your connection works.*

## **Endpoint Documentation**

You can reach the detailed documentation of every endpoint you can use at [https://docs.netsipp.com/api](https://docs.netsipp.com/api). The related API headings are:

- **Accounts**, **Users**, **Contacts** and **Projects**
- **Conversations**, **Call Scripts** and **Breaks**
- **CRM**, **Quick Replies** and **Ticket**
- **Reports** and **Auto Dialer**

Under each heading you will find the address of the relevant endpoint, the parameters to send and sample requests and responses.

***Note:** The Public API is different from the session or application permission flow used to log in to the portal; in this API the identity is always provided with the API Key.*

## Site menu

- [Introduction](https://docs.netsipp.com/en)
- **Authentication**
  - [Create Account](https://docs.netsipp.com/en/kimlik-dogrulama/hesap-olustur)
  - [User Login](https://docs.netsipp.com/en/kimlik-dogrulama/kullanici-girisi)
  - [Password Reset](https://docs.netsipp.com/en/kimlik-dogrulama/sifre-sifirlama)
- **Organization**
  - [Organization List ](https://docs.netsipp.com/en/organizasyon/organizasyon-listesi)
  - [Organization Settings](https://docs.netsipp.com/en/organizasyon/ayarlar)
  - [Organization Schema](https://docs.netsipp.com/en/organizasyon/sema)
  - [Wallboard](https://docs.netsipp.com/en/organizasyon/tv-ekrani)
  - [Flow Designer](https://docs.netsipp.com/en/organizasyon/akis-diyagrami)
  - [Directory Management](https://docs.netsipp.com/en/organizasyon/rehber)
  - [Break Management](https://docs.netsipp.com/en/organizasyon/molalar)
  - [Supervisor](https://docs.netsipp.com/en/organizasyon/supervisor)
  - [Auto Dialer](https://docs.netsipp.com/en/organizasyon/otomatik-arama)
  - [Public API](https://docs.netsipp.com/en/organizasyon/public-api) ← this page
  - [FCT](https://docs.netsipp.com/en/organizasyon/fct)
- **Marketplace**
  - [Product Store](https://docs.netsipp.com/en/pazar-yeri/katalog)
  - [Shopping Cart](https://docs.netsipp.com/en/pazar-yeri/sepet)
  - [Checkout Page](https://docs.netsipp.com/en/pazar-yeri/odeme)
  - [Product Detail Page](https://docs.netsipp.com/en/pazar-yeri/urun-detay)
- **Products**
  - [Cloud PBX Packages](https://docs.netsipp.com/en/urunler/bulut-santral-paketleri)
  - [Agent Module](https://docs.netsipp.com/en/urunler/agent-modulu)
  - [Agent Screen Applications](https://docs.netsipp.com/en/urunler/agent-ekrani-uygulamalari)
  - [Supervisor Module](https://docs.netsipp.com/en/urunler/supervisor-modulu)
  - [Wallboard](https://docs.netsipp.com/en/urunler/tv-ekrani-modulu)
  - [Call Recording](https://docs.netsipp.com/en/urunler/gorusme-kaydi)
  - [Call Transcript](https://docs.netsipp.com/en/urunler/cagri-transkript)
  - [Quality Evaluation Module](https://docs.netsipp.com/en/urunler/kalite-degerlendirme-modulu)
  - [Post-Call Survey](https://docs.netsipp.com/en/urunler/cagri-sonu-anket)
  - [Call Center Reports](https://docs.netsipp.com/en/urunler/cagri-merkezi-raporlari)
  - [Netsipp Live Chat](https://docs.netsipp.com/en/urunler/netsipp-canli-chat)
  - [Directory Lookup](https://docs.netsipp.com/en/urunler/rehber-sorgusu)
  - [PBX Extension](https://docs.netsipp.com/en/urunler/toplam-dahili-adedi)
  - [Telephone Line (Trunk) Package](https://docs.netsipp.com/en/urunler/telefon-hatti)
  - [Netsipp Webhook](https://docs.netsipp.com/en/urunler/netsipp-webhook)
  - [Custom API](https://docs.netsipp.com/en/urunler/ozel-api-custom)
  - [Netsipp Softphone Desktop](https://docs.netsipp.com/en/urunler/netsipp-softphone-masaustu)
  - [Netsipp Softphone Mobile](https://docs.netsipp.com/en/urunler/netsipp-softphone-mobil)
  - [Netgsm SMS](https://docs.netsipp.com/en/urunler/netgsm-sms)
  - [NetIYS](https://docs.netsipp.com/en/urunler/netiys)
  - [Netsipp Mail](https://docs.netsipp.com/en/urunler/netsipp-mail)
  - [Physical IP FCT](https://docs.netsipp.com/en/urunler/fiziki-ip-fct)
  - [Auto Dialer](https://docs.netsipp.com/en/urunler/otomatik-arama-urun)
  - [eSIM-FCT](https://docs.netsipp.com/en/urunler/ip-fct)
  - [NGN Trunk Service](https://docs.netsipp.com/en/urunler/ngn-trunk-hizmeti)
  - [Show Calling Number](https://docs.netsipp.com/en/urunler/arayan-numarayi-goster)
- **PBX Settings**
  - [Extension Management](https://docs.netsipp.com/en/pbx-ayarlari/dahililer)
  - [Queue Management](https://docs.netsipp.com/en/pbx-ayarlari/kuyruklar)
  - [Announcement Management](https://docs.netsipp.com/en/pbx-ayarlari/anonslar)
  - [IVR Menu Management](https://docs.netsipp.com/en/pbx-ayarlari/ivr-listesi)
  - [Department Management](https://docs.netsipp.com/en/pbx-ayarlari/departmanlar)
  - [Team Management](https://docs.netsipp.com/en/pbx-ayarlari/takimlar)
  - [Outbound Call Rules](https://docs.netsipp.com/en/pbx-ayarlari/giden-hatlar)
  - [Inbound Call Rules](https://docs.netsipp.com/en/pbx-ayarlari/gelen-hatlar)
  - [Telephone Line Management](https://docs.netsipp.com/en/pbx-ayarlari/trunk-yonetimi)
  - [Sound Library](https://docs.netsipp.com/en/pbx-ayarlari/sistem-kayitlari)
  - [General Settings](https://docs.netsipp.com/en/pbx-ayarlari/genel-ayarlar)
  - [Time Condition Management](https://docs.netsipp.com/en/pbx-ayarlari/zaman-kosullari)
- **Projects and Tickets**
  - [Projects](https://docs.netsipp.com/en/projeler-ve-biletler/proje-detay)
- **Users and Roles**
  - [Agent (User) Management](https://docs.netsipp.com/en/kullanicilar-ve-roller/agent-yonetimi)
  - [Role Management](https://docs.netsipp.com/en/kullanicilar-ve-roller/roller)
- **Profile and Account**
  - [Profile & Account Settings](https://docs.netsipp.com/en/profil-ve-hesap/profil)
- **Reports**
  - [Call Reports ](https://docs.netsipp.com/en/raporlar/cagri-raporlari)
  - [Agent Call Report](https://docs.netsipp.com/en/raporlar/agent-cagri)
  - [CDR Report](https://docs.netsipp.com/en/raporlar/cdr)
  - [Organization Daily Report](https://docs.netsipp.com/en/raporlar/gunluk-organizasyon)
  - [Queue Daily Report](https://docs.netsipp.com/en/raporlar/kuyruk-gunluk)
  - [Queue Detail Report](https://docs.netsipp.com/en/raporlar/kuyruk-detay)
- **Integrations**
  - [Zoho CRM ](https://docs.netsipp.com/en/entegrasyonlar/zoho-crm)
  - [ikas ](https://docs.netsipp.com/en/entegrasyonlar/ikas)
  - [Aidatım](https://docs.netsipp.com/en/entegrasyonlar/aidatim)
  - [ArnivaIsp](https://docs.netsipp.com/en/entegrasyonlar/arnivaisp)
  - [Dia](https://docs.netsipp.com/en/entegrasyonlar/dia)
  - [Ennet](https://docs.netsipp.com/en/entegrasyonlar/ennet)
  - [Freshdesk](https://docs.netsipp.com/en/entegrasyonlar/freshdesk)
  - [Halı Pratik](https://docs.netsipp.com/en/entegrasyonlar/hali-pratik)
  - [Hubspot](https://docs.netsipp.com/en/entegrasyonlar/hubspot)
  - [Kommo](https://docs.netsipp.com/en/entegrasyonlar/kommo)
  - [Logo](https://docs.netsipp.com/en/entegrasyonlar/logo)
  - [Monday](https://docs.netsipp.com/en/entegrasyonlar/monday)
  - [NegroPOS](https://docs.netsipp.com/en/entegrasyonlar/negropos)
  - [Slack](https://docs.netsipp.com/en/entegrasyonlar/slack)
  - [Teamgram](https://docs.netsipp.com/en/entegrasyonlar/teamgram)
  - [Ticimax](https://docs.netsipp.com/en/entegrasyonlar/ticimax)
  - [T-Soft](https://docs.netsipp.com/en/entegrasyonlar/tsoft)
  - [Usta Pos](https://docs.netsipp.com/en/entegrasyonlar/usta-pos)
  - [WhatsApp](https://docs.netsipp.com/en/entegrasyonlar/whatsapp)
  - [Zendesk](https://docs.netsipp.com/en/entegrasyonlar/zendesk)
  - [Zoho Desk](https://docs.netsipp.com/en/entegrasyonlar/zoho-desk)
  - [Wiradius](https://docs.netsipp.com/en/entegrasyonlar/wiradius)
  - [Wordpress Woocommerce](https://docs.netsipp.com/en/entegrasyonlar/wordpress-woocommerce)

## Full documentation

- [llms.txt](https://docs.netsipp.com/llms.txt): Site index — every page with its summary
- [llms-full.txt](https://docs.netsipp.com/llms-full.txt): Plain-text copy of every document in one file