# Quickstart

{% hint style="warning" %}
**Important Notice**

This documentation is only a **preview** of our API. It provides a high-level overview of what the API can do and which types of data objects you can expect.\
\
The **official API Reference** — including full technical specifications, JSON schemas, sample results, error codes, and authentication details — is only available after signing up to our platform.\
\ <a href="https://app.scrapin.io/auth/register" class="button primary">Sign up to access the full API Reference</a>
{% endhint %}

***

This QuickStart is designed to help you quickly understand:

* **What our API does**: the main endpoints available and the kind of data they deliver.
* **How to use it**: what inputs are required and what objects are returned.
* **Where it fits**: common use cases such as sales enrichment, recruiting workflows, CRM integration, or analytics pipelines.

It’s **not a technical deep dive**, but a way to educate you and your team on the possibilities of the API before accessing the full reference.

***

### How It Works

1. **Explore endpoints in this preview**\
   Each endpoint page explains at a high level:
   * What the endpoint does.
   * The inputs it accepts (e.g., Social URL, name, domain).
   * The outputs it returns (structured person, company, or activity objects).
   * Typical use cases and benefits.
2. **Understand delivery & integration**\
   Data can be delivered via simple API calls or bulk delivery formats (CSV, JSON, Parquet, etc.), depending on your needs.\
   Our team can also help with **cloud integrations** (Amazon S3, Google Cloud, Azure).
3. **Get full access**\
   To access the **full API Reference** (with technical specifications, JSON examples, error codes, and complete object schemas), you need to **sign up for the platform** and get credentials.