# List Email Campaigns GET https://services.leadconnectorhq.com/emails/locations/{locationId}/campaigns/emails Get list of email campaigns for a location ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `emails/campaigns.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | Location ID | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `limit` | number | No | Number of campaigns to return. Defaults to 10, minimum is 1, maximum is 20 | | `offset` | number | No | Number of campaigns to skip for pagination. Defaults to 0, minimum is 0 | | `search` | string | No | Search text for campaign name | | `status` | string | No | Filter by campaign status | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/emails/locations/{locationId}/campaigns/emails": { "get": { "summary": "List Email Campaigns", "operationId": "listEmailCampaigns", "description": "Get list of email campaigns for a location", "parameters": [ { "name": "locationId", "required": true, "in": "path", "description": "Location ID", "schema": { "example": "ve9EPM428h8vShlRW1KT", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of campaigns to return. Defaults to 10, minimum is 1, maximum is 20", "schema": { "minimum": 1, "maximum": 20, "default": 10, "example": 10, "type": "number" } }, { "name": "offset", "required": false, "in": "query", "description": "Number of campaigns to skip for pagination. Defaults to 0, minimum is 0", "schema": { "minimum": 0, "default": 0, "example": 0, "type": "number" } }, { "name": "search", "required": false, "in": "query", "description": "Search text for campaign name", "schema": { "example": "newsletter", "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "Filter by campaign status", "schema": { "example": "all", "enum": [ "all", "sent", "failed", "archived", "draft", "processing", "scheduled", "cancelled", "paused" ], "type": "string" } }, { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEmailCampaignsPublicV2ResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "403": { "description": "The token does not have access to this location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidLocationDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "Location-Access": [ "emails/campaigns.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "ListEmailCampaignsPublicV2ResponseDto": { "type": "object", "properties": { "campaigns": { "description": "List of email campaigns", "example": [ { "id": "67f15c2ae99226d5bcccb8f3", "name": "February Newsletter", "status": "sent", "deleted": false, "createdAt": "2025-07-24T11:55:43.598Z", "updatedAt": "2026-02-09T04:49:12.322Z" } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Campaign ID", "example": "67f15c2ae99226d5bcccb8f3" }, "source": { "type": "string", "description": "Source of the campaign", "example": "email-campaign" }, "sourceId": { "type": "string", "description": "Source ID of the campaign", "example": "bulkRequest_abc123" }, "name": { "type": "string", "description": "Campaign name", "example": "February Newsletter" }, "status": { "type": "string", "description": "Campaign status", "example": "sent", "enum": [ "all", "sent", "failed", "archived", "draft", "processing", "scheduled", "cancelled", "paused" ] }, "campaignType": { "type": "string", "description": "Campaign type", "example": "bulk-email" }, "campaignCategory": { "type": "string", "description": "Campaign category", "example": "email-campaign" }, "variations": { "description": "AB test variation identifiers (available only for AB test campaigns)", "example": [ { "sourceId": "9MhVcU7dTdLI7XOU1Vdt", "isWinner": true } ], "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "Variation source ID for stats lookup", "example": "9MhVcU7dTdLI7XOU1Vdt" }, "isWinner": { "type": "boolean", "description": "Whether this is the winning variation", "example": true } }, "required": [ "sourceId", "isWinner" ], "title": "EmailCampaignVariationPublicV2Dto" } }, "deleted": { "type": "boolean", "description": "Whether the campaign is deleted", "example": false }, "createdAt": { "type": "string", "description": "Created at timestamp", "example": "2025-07-24T11:55:43.598Z" }, "updatedAt": { "type": "string", "description": "Last updated timestamp", "example": "2026-02-09T04:49:12.322Z" } }, "required": [ "id", "deleted", "createdAt", "updatedAt" ], "title": "EmailCampaignPublicV2Dto" } }, "total": { "type": "number", "description": "Total count of email campaigns", "example": 25 }, "traceId": { "type": "string", "description": "Trace ID of the request", "example": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4" } }, "required": [ "campaigns", "total" ], "title": "ListEmailCampaignsPublicV2ResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "InvalidLocationDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code for invalid location access", "example": 403 }, "message": { "type": "string", "description": "Error message describing the location access failure", "example": "The token does not have access to this location" } }, "title": "InvalidLocationDTO" }, "NotFoundDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code for not found", "example": 404 }, "message": { "type": "string", "description": "Error message describing the not found failure", "example": "Not Found" }, "error": { "type": "string", "description": "Error type identifier", "example": "The requested resource was not found" } }, "title": "NotFoundDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/emails/locations//campaigns/emails' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/emails/locations//campaigns/emails', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/emails/locations/{locationId}/campaigns/emails" headers = { "Authorization": "Bearer ", "Version": "v3" } response = requests.get(url, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/emails/locations//campaigns/emails', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/emails/locations//campaigns/emails") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/emails/locations//campaigns/emails" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/emails/locations//campaigns/emails") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/emails/locations//campaigns/emails' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```