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

# Quickstart Guide

> Get started with the Tuesday Leads API in under 5 minutes

## Get Your API Key

To get started with the Tuesday Leads API, you'll need an API key:

<Steps>
  <Step title="Sign Up">
    Create an account at [Tuesday Dashboard](https://app.tuesday.so)
  </Step>

  <Step title="Generate API Key">
    Navigate to the API Keys section and generate a new key
  </Step>

  <Step title="Secure Your Key">
    Store your API key securely - treat it like a password
  </Step>
</Steps>

<Warning>
  Never expose your API key in client-side code or public repositories. Always use environment variables or secure key management systems.
</Warning>

## Test Your Setup

Verify your API key works by making a test request to the Auth API:

<CodeGroup>
  ```bash cURL theme={null}
  curl --location 'https://api.tuesday.so/api/v1/public/auth' \
  --header 'X-API-KEY: your-api-key-here'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.tuesday.so/api/v1/public/auth', {
    headers: {
      'X-API-KEY': 'your-api-key-here'
    }
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'X-API-KEY': 'your-api-key-here'
  }

  response = requests.get(
      'https://api.tuesday.so/api/v1/public/auth',
      headers=headers
  )

  print(response.json())
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init();

  curl_setopt($ch, CURLOPT_URL, 'https://api.tuesday.so/api/v1/public/auth');
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'X-API-KEY: your-api-key-here'
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);
  print_r($data);
  ?>
  ```
</CodeGroup>

**Expected Response:**

```json theme={null}
{
    "data": {
        "name": "Your Workspace",
        "id": "ws30ngrb03luqxcl27",
        "user_id": "usr19g6tln8rlii8"
    },
    "statusCode": 200,
    "message": "Success"
}
```

## Your First API Call

Let's fetch a person's profile using their LinkedIn URL:

<CodeGroup>
  ```bash cURL theme={null}
  curl --location 'https://api.tuesday.so/api/v1/people/profile?linkedin_url=https://www.linkedin.com/in/david-addiss-4725189' \
  --header 'X-API-KEY: your-api-key-here'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.tuesday.so/api/v1/people/profile?linkedin_url=https://www.linkedin.com/in/david-addiss-4725189',
    {
      headers: {
        'X-API-KEY': 'your-api-key-here'
      }
    }
  );

  const profile = await response.json();
  console.log(profile);
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.tuesday.so/api/v1/people/profile"
  params = {
      "linkedin_url": "https://www.linkedin.com/in/david-addiss-4725189"
  }
  headers = {
      "X-API-KEY": "your-api-key-here"
  }

  response = requests.get(url, params=params, headers=headers)
  profile = response.json()
  print(profile)
  ```
</CodeGroup>

**Response:**

```json theme={null}
{
    "data": {
        "name": "David Addiss",
        "first_name": "David",
        "last_name": "Addiss",
        "title": "Energy Consultant",
        "city": "St Petersburg",
        "state": "Florida",
        "country": "United States",
        "linkedin_url": "https://www.linkedin.com/in/david-addiss-4725189",
        "organizations.name": "Semper Solaris",
        "organizations.website_url": "https://www.sempersolaris.com"
    },
    "statusCode": 200,
    "message": "Success"
}
```

## Common Use Cases

<CardGroup cols={2}>
  <Card title="CRM Enrichment" icon="database">
    Enrich your existing contacts with additional profile data and verified contact information.
  </Card>

  <Card title="Lead Generation" icon="target">
    Find and qualify new prospects using company and people search APIs.
  </Card>

  <Card title="Sales Intelligence" icon="chart-line">
    Research prospects and companies before outreach with detailed profiles and insights.
  </Card>

  <Card title="Market Research" icon="magnifying-glass">
    Analyze companies and their employees to understand market trends and opportunities.
  </Card>
</CardGroup>

## Best Practices

<Tip>
  **Start Small**: Begin with basic profile lookups before moving to advanced search queries
</Tip>

<Tip>
  **Batch Requests**: For multiple profiles, consider the rate limits and plan your requests accordingly
</Tip>

<Tip>
  **Cache Results**: Store frequently accessed data to reduce API calls and improve performance
</Tip>

<Tip>
  **Error Handling**: Always implement proper error handling for API timeouts and rate limits
</Tip>

## Next Steps

Now that you're set up, explore these key areas:

* [Authentication](/authentication) - Learn about API key management
* [Rate Limits & Credits](/rate-limits-and-credits) - Understand usage limits
* [People APIs](/api-reference/people/profile) - Access professional profiles
* [Company APIs](/api-reference/company/profile) - Get company intelligence
* [Search APIs](/api-reference/people/search) - Find prospects at scale

## Need Help?

<Card title="API Reference" icon="code" href="/api-reference/auth/check-api-key">
  Complete API documentation with examples
</Card>