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

# Get Campaigns

> Get Campaigns

Get Campaigns

```http theme={null}
GET https://services.leadconnectorhq.com/emails/schedule
```

## Autorización

<ParamField header="Authorization" type="string" required>
  Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
</ParamField>

<ParamField header="Version" type="string" required default="2021-07-28">
  Versión de la API.
</ParamField>

## Query parameters

<ParamField query="locationId" type="string" required default="ohjiah0wdg3bzmzacvd6">
  Account ID to fetch campaigns from
</ParamField>

<ParamField query="limit" type="number" default="7">
  Maximum number of campaigns to return. Defaults to 10, maximum is 100
</ParamField>

<ParamField query="offset" type="number" default="0">
  Number of campaigns to skip for pagination
</ParamField>

<ParamField query="status" type="string">
  Filter by schedule status
</ParamField>

<ParamField query="emailStatus" type="string">
  Filter by email delivery status
</ParamField>

<ParamField query="name" type="string" default="Black Friday Campaign">
  Filter campaigns by name
</ParamField>

<ParamField query="parentId" type="string" default="folder123">
  Filter campaigns by parent folder ID
</ParamField>

<ParamField query="limitedFields" type="boolean" default="false">
  When true, returns only essential campaign fields like id, templateDataDownloadUrl, updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false, returns complete campaign data including meta information, bulkRequestStatusInfo, ABTestInfo, resendScheduleInfo and all other campaign properties
</ParamField>

<ParamField query="archived" type="boolean" default="false">
  Filter archived campaigns
</ParamField>

<ParamField query="campaignsOnly" type="boolean" default="false">
  Return only campaigns, excluding folders
</ParamField>

<ParamField query="showStats" type="boolean" default="true">
  When true, returns campaign statistics including delivered count, opened count, clicked count and revenue if available for the campaign. When false, returns campaign data without statistics.
</ParamField>

## Respuestas

<Accordion title="200 - Success">
  <ResponseField name="schedules" type="object[]" required>
    The list of campaigns

    <Expandable title="cada item">
      <ResponseField name="name" type="string" required default="Untitled new campaign" />

      <ResponseField name="repeatAfter" type="string" required />

      <ResponseField name="id" type="string" required />

      <ResponseField name="parentId" type="string" required />

      <ResponseField name="childCount" type="number" required />

      <ResponseField name="campaignType" type="string" required />

      <ResponseField name="bulkActionVersion" type="string" required />

      <ResponseField name="_id" type="string" required />

      <ResponseField name="status" type="string" required />

      <ResponseField name="sendDays" type="string[]" required />

      <ResponseField name="deleted" type="boolean" required />

      <ResponseField name="migrated" type="boolean" required />

      <ResponseField name="archived" type="boolean" required />

      <ResponseField name="hasTracking" type="boolean" required />

      <ResponseField name="isPlainText" type="boolean" required />

      <ResponseField name="hasUtmTracking" type="boolean" required />

      <ResponseField name="enableResendToUnopened" type="boolean" required />

      <ResponseField name="locationId" type="string" required />

      <ResponseField name="templateId" type="string" required />

      <ResponseField name="templateType" type="string" required />

      <ResponseField name="createdAt" type="string" required />

      <ResponseField name="updatedAt" type="string" required />

      <ResponseField name="__v" type="number" required />

      <ResponseField name="documentId" type="string" required />

      <ResponseField name="downloadUrl" type="string" required />

      <ResponseField name="templateDataDownloadUrl" type="string" required />

      <ResponseField name="child" type="string[]" required />
    </Expandable>
  </ResponseField>

  <ResponseField name="total" type="string[]" required>
    The total number of campaigns
  </ResponseField>

  <ResponseField name="traceId" type="string" required>
    Trace Id
  </ResponseField>

  ```json theme={null}
  {
    "schedules": [
      {
        "name": "Untitled new campaign",
        "repeatAfter": "string",
        "id": "string",
        "parentId": "string",
        "childCount": 0,
        "campaignType": "string",
        "bulkActionVersion": "string",
        "_id": "string",
        "status": "string",
        "sendDays": [
          "string"
        ],
        "deleted": true,
        "migrated": true,
        "archived": true,
        "hasTracking": true,
        "isPlainText": true,
        "hasUtmTracking": true,
        "enableResendToUnopened": true,
        "locationId": "string",
        "templateId": "string",
        "templateType": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "__v": 0,
        "documentId": "string",
        "downloadUrl": "string",
        "templateDataDownloadUrl": "string",
        "child": [
          "string"
        ]
      }
    ],
    "total": [
      "string"
    ],
    // truncado: 2 lineas mas
  }
  ```
</Accordion>

<Accordion title="400 - Bad Request">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="401 - Unauthorized">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="403 - The token does not have access to this account">
  <ResponseField name="statusCode" type="number" default="403" />

  <ResponseField name="message" type="string" default="The token does not have access to this account" />

  ```json theme={null}
  {
    "statusCode": 403,
    "message": "The token does not have access to this account"
  }
  ```
</Accordion>

<Accordion title="404 - Not Found">
  <ResponseField name="statusCode" type="number" default="404" />

  <ResponseField name="message" type="string" default="Not Found" />

  <ResponseField name="error" type="string" default="The requested resource was not found" />

  ```json theme={null}
  {
    "statusCode": 404,
    "message": "Not Found",
    "error": "The requested resource was not found"
  }
  ```
</Accordion>

<Accordion title="422 - Unprocessable Entity">
  ```json theme={null}
  {}
  ```
</Accordion>

## Ejemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET 'https://services.leadconnectorhq.com/emails/schedule' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -H 'Version: 2021-07-28'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://services.leadconnectorhq.com/emails/schedule', {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
      Version: '2021-07-28',
    },
  });
  const data = await response.json();
  ```

  ```python Python theme={null}
  import os, requests
  response = requests.request(
      'GET',
      'https://services.leadconnectorhq.com/emails/schedule',
      headers={
          'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
          'Version': '2021-07-28',
      },
  )
  data = response.json()
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init('https://services.leadconnectorhq.com/emails/schedule');
  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_CUSTOMREQUEST => 'GET',
      CURLOPT_HTTPHEADER => [
          'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
          'Version: 2021-07-28',
      ],
  ]);
  $data = json_decode(curl_exec($ch), true);
  ```
</CodeGroup>