### GET Request Example

Source: https://docs.amplemarket.com/api-reference/introduction

Example of a GET request to retrieve a specific resource, including the Authorization header.

```javascript
GET /email-validations/1
Authorization: Bearer {{api-key}}
```

--------------------------------

### cURL Request Example

Source: https://docs.amplemarket.com/api-reference/introduction

Example of making a GET request using cURL, demonstrating how to include the Authorization header.

```bash
curl /email-validations/1 \
  -H "Authorization: Bearer {{api-key}}
```

--------------------------------

### Start People Enrichment Request using cURL

Source: https://docs.amplemarket.com/guides/people-search

Initiate a people enrichment request using cURL. This example demonstrates sending lead data and authentication headers.

```bash
curl -X POST https://api.amplemarket.com/people/enrichment-requests \
	-H "Authorization: Bearer {{API Key}}" \
	-H "Content-Type: application/json" \
	-d '{
  "leads": [{"linkedin_url": "https://www.linkedin.com/in/person-1"},
    {"email": "person@example.com"}
  ]
}'
```

--------------------------------

### Insufficient Credits Error Response Example

Source: https://docs.amplemarket.com/api-reference/people-enrichment/start-enrichment-request

This example shows an error response when the user has insufficient credits to perform the requested enrichment operation.

```json
{
  "_errors": [
    {
      "code": "insufficient_credits",
      "title": "Insufficient Credits",
      "detail": "You do not have enough credits to perform this operation."
    }
  ],
  "object": "error"
}
```

--------------------------------

### Successful Response Example

Source: https://docs.amplemarket.com/api-reference/companies-enrichment/cancel-enrichment-request

This example shows the JSON response when a company enrichment batch is successfully canceled. It includes the batch ID, status, and an empty results array.

```json
{
  "id": 37,
  "object": "company_enrichment",
  "status": "canceled",
  "results": [],
  "_links": {
    "self": {
      "href": "/companies/enrichment-requests/37"
    }
  }
}
```

--------------------------------

### Successful Contact Retrieval Example

Source: https://docs.amplemarket.com/api-reference/contacts/get-contacts

This example demonstrates the structure of a successful response when retrieving contacts. It includes details for a single contact, such as ID, name, email, and LinkedIn URL.

```json
{
  "contacts": [
    {
      "id": "019e927c-9e97-7492-b2a3-1768328a48c0",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "linkedin_url": "https://linkedin.com/in/john-doe",
      "email": "john.doe@example.com",
      "time_zone": "Europe/Lisbon",
      "location": "Lisbon, Lisbon, Portugal",
      "title": "Software Engineer",
      "company_domain": "amplemarket.com",
      "company_name": "Amplemarket",
      "owner": "user@example.com",
      "last_contacted_at": "2026-06-02T11:55:01Z",
      "phone_numbers": [
        {
          "id": "019e927c-9d6d-7f64-ae6d-7ff76750c148",
          "object": "phone_number",
          "number": "+1 639-300-0002",
          "type": "mobile",
          "source": "amplemarket",
          "kind": "mobile"
        }
      ]
    }
  ]
}
```

--------------------------------

### Batch Accepted Response Example

Source: https://docs.amplemarket.com/api-reference/people-enrichment/start-enrichment-request

This example shows a successful response when a batch of person enrichment requests is accepted. The response includes a batch ID, status, and links.

```json
{
  "id": 10,
  "object": "person_enrichment",
  "status": "queued",
  "results": [],
  "_links": {
    "self": {
      "href": "/people/enrichment-requests/10"
    }
  }
}
```

--------------------------------

### Missing Field Error Response Example

Source: https://docs.amplemarket.com/api-reference/people-enrichment/start-enrichment-request

This example illustrates an error response when a required field, such as 'leads', is missing from the request body.

```json
{
  "_errors": [
    {
      "code": "missing_field",
      "title": "Missing Field",
      "detail": "Missing field from request: leads",
      "source": {
        "pointer": "/leads"
      }
    }
  ],
  "object": "error"
}
```

--------------------------------

### Product Demo Modal Initialization

Source: https://amplemarket.com/blog

Initializes the product demo modal, setting its display to 'block' on window load. It also sets up event listeners for the Wistia player and modal close button.

```javascript
window.addEventListener('load', () => {
  const wistiaPlayer = document.querySelector('wistia-player');
  const closeModalBtn = document.querySelector('.am-close-product-demo');
  if (demoModal) demoModal.style.display = 'none';
  let refresh = false;
  let href;

  document.body.addEventListener('click', (event) => {
    if (wistiaPlayer && wistiaPlayer.contains(event.target)) {
      event.stopPropagation();
    }
  });

  if (wistiaPlayer) {
    wistiaPlayer.addEventListener('ready', (event) => {
      const video = event.target;
      closeModalBtn.addEventListener('click', () => video.pause());
      if (demoModal) demoModal.addEventListener('click', () => video.pause());
    });
  }

  function openModal() {
    const demoButton = 
```

--------------------------------

### OpenAPI Specification for Get Account Info

Source: https://docs.amplemarket.com/api-reference/account-info

This OpenAPI 3.0.1 specification defines the GET /account-info endpoint for retrieving account details. It includes server details, security schemes, and response examples.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /account-info:
    get:
      tags:
        - Account
      summary: Get account details
      description: Get account details
      parameters: []
      responses:
        '200': 
          description: OK
          content:
            application/json:
              examples:
                OK:
                  value:
                    id: 019e927c-b00c-71cf-9a56-eda881eb33dd
                    name: Test Account 111
              schema:
                $ref: "#/components/schemas/response_account_details_object"
components:
  schemas:
    response_account_details_object:
      type: object
      required:
        - id
        - name
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

--------------------------------

### OpenAPI Specification for Retrieve Job Opening

Source: https://docs.amplemarket.com/api-reference/job-openings/get-job-opening

This OpenAPI 3.0.1 specification defines the `GET /job-openings/{id}` endpoint for retrieving a job opening. It includes parameters, successful response examples, and error response examples.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /job-openings/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Job opening ID
        schema:
          type: string
    get:
      tags:
        - Job Openings
      summary: Retrieve Job Opening
      description: Retrieve Job Opening
      parameters: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    id: e159ac98-d4ce-4fc2-8e31-7ebc6596ab45
                    title: Senior Software Engineer
                    url: https://example.com/jobs/123
                    raw_location: Remote - US
                    first_seen_at: '2026-04-01T12:00:00Z'
                    seniorities:
                      - Senior
                    departments:
                      - Engineering & Technical
                    job_functions:
                      - Software Development
                    description: Full job description
                    company_name: Example Inc
                    company_domain: example.com
                    raw_salary: $140k-$180k
                    contract_types:
                      - remote
                    last_seen_at: '2026-04-02T12:00:00Z'
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  title:
                    nullable: true
                    type: string
                  url:
                    nullable: true
                    type: string
                  raw_location:
                    nullable: true
                    type: string
                  first_seen_at:
                    type: string
                    format: date_time
                    nullable: true
                  seniorities:
                    type: array
                    items:
                      type: string
                  departments:
                    type: array
                    items:
                      type: string
                  job_functions:
                    type: array
                    items:
                      type: string
                  description:
                    nullable: true
                    type: string
                  company_name:
                    nullable: true
                    type: string
                  company_domain:
                    nullable: true
                    type: string
                  raw_salary:
                    nullable: true
                    type: string
                  contract_types:
                    type: array
                    items:
                      type: string
                  last_seen_at:
                    type: string
                    format: date_time
                    nullable: true
        '404':
          description: Not found
          content:
            application/json:
              examples:
                Not found:
                  value:
                    _errors:
                      - code: not_found
                        title: Not Found
                        detail: Job opening not found
                    object: error
              schema:
                $ref: '#/components/schemas/response_errors_object'
        '410':
          description: Gone
          content:
            application/json:
              examples:
                Gone:
                  value:
                    _errors:
                      - code: gone
                        title: Gone
                        detail: Job opening is no longer available
                    object: error
              schema:
                $ref: '#/components/schemas/response_errors_object'
components:
  schemas:
    response_errors_object:
      type: object
      required:
        - object
        - _errors
      additionalProperties: false
      properties:
        object:
          type: string
          enum:
            - error
        _errors:
          type: array
          items:
            $ref: '#/components/schemas/response_error_object'
        _links:
          $ref: '#/components/schemas/response_links_object'
    response_error_object:
      type: object
      required:
        - code
        - title
        - detail
      additionalProperties: false
      properties:
        code:
          type: string
        title:
          type: string
        detail:

```

--------------------------------

### Retrieve Contacts using Go

Source: https://docs.amplemarket.com/api-reference/contacts/get-contacts

This Go program demonstrates how to fetch contacts using the net/http package. It constructs the URL, adds the Authorization header, and prints the response. Replace {id} and <token> with your actual values.

```go
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.amplemarket.com/contacts?ids[]={id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

--------------------------------

### Example Task Object Structure

Source: https://docs.amplemarket.com/guides/tasks

This JSON object represents a typical task within the Amplemarket system. It includes details such as ID, status, due date, associated user, and contact information.

```json
{
  "id": "0198f652-bd65-7bc1-99e8-c9801331ecc7",
  "automatic": false,
  "type": "phone_call",
  "status": "scheduled",
  "due_on": "2025-08-29T12:54:34Z",
  "finished_on": null,
  "notes": "custom task notes",
  "sequence_key": null,
  "sequence_name": null,
  "user_id": "0198f652-bc9b-79c2-8b91-60e1bd43e45d",
  "user_email": "user@example.com",
  "contact": {
    "id": "0198f652-bd62-7cb8-9c22-05be51e2a231",
    "name": "User Amplemarket",
    "email": "user@amplemarket.com"
  }
}
```

--------------------------------

### OpenAPI Specification for List Dispositions

Source: https://docs.amplemarket.com/api-reference/calls/get-call-dispositions

This OpenAPI 3.0.1 specification defines the GET /calls/dispositions endpoint, including request parameters, response structure, and example successful responses with disposition data.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /calls/dispositions:
    get:
      tags:
        - Calls
      summary: List dispositions
      description: List dispositions
      parameters: []
      responses:
        '200':  
          description: successful
          content:
            application/json:
              examples:
                successful:
                  value:
                    dispositions:
                      - id: 019e927c-2468-7ee9-97ed-3fddd49ff317
                        name: No Answer
                        slug: no_answer
                        action: next_stage
                      - id: 019e927c-2468-7d69-8c2c-adbe610be45d
                        name: Left VM
                        slug: no_answer_voicemail
                        action: next_stage
                      - id: 019e927c-2468-717e-8ba5-bc4f46f8fe38
                        name: Wrong Number
                        slug: wrong_number
                        action: next_stage
                      - id: 019e927c-2469-79df-b992-d0ae7110a0ce
                        name: Busy call later
                        slug: busy
                        action: next_stage
                      - id: 019e927c-2469-7b07-9ce6-f0591189d6bd
                        name: Not interested
                        slug: not_interested
                        action: complete
                      - id: 019e927c-2469-72f0-b484-00391bb21708
                        name: Interested
                        slug: interested
                        action: complete
              schema:
                type: object
                properties:
                  dispositions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        slug:
                          nullable: true
                          type: string
                        name:
                          type: string
                        action:
                          type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

--------------------------------

### Next.js Client-Side Initialization Script

Source: https://status.amplemarket.com/

This script is part of the Next.js framework for client-side bootstrapping. It initializes the application's runtime and loads necessary chunks.

```javascript
(self.__next_f=self.__next_f||[]).push([0])self.__next_f.push([1,"1:\"$Sreact.fragment\"\n2:I[339756,[\"/_next/static/chunks/0xp~wg5m99o8h.js\",\"/_next/static/chunks/0.om4iw1bthpt.js\"],\"default\" ]\n3:I[837457,[\"/_next/static/chunks/0xp~wg5m99o8h.js\",\"/_next/static/chunks/0.om4iw1bthpt.js\"],\"default\" ]\n6:I[897367,[\"/_next/static/chunks/0xp~wg5m99o8h.js\",\"/_next/static/chunks/0.om4iw1bthpt.js\"],\"OutletBoundary\" ]\n7:\"$Sreact.suspense\"\na:I[897367,[\"/_next/static/chunks/0xp~wg5m99o8h.js\",\"/_next/static/chunks/0.om4iw1bthpt.js\"],\"ViewportBoundary\" ]\nc:I[897367,[\"/_next/static/chunks/0xp~wg5m99o8h.js\",\"/_next/static/chunks/0.om4iw1bthpt.js\"],\"MetadataBoundary\" ]\ne:I[168027,[],\"default\",1]\n:HL[\"/_next/static/chunks/0lyvanl39ubp_.css\",\"style\"]\n:HL[\"/_next/static/chunks/14iqs848fqk~1.css\",\"style\"]\n:HL[\"/_next/static/chunks/0l2_ujm1mrnwo.css\",\"style\"]\n:HL[\"/_next/static/chunks/08cvvwaabsqjr.css\",\"style\"]\n"])
```

```javascript
self.__next_f.push([1,"0:{\"P\":null,\"c\":[\"\",\"en-us\",\"amplemarketstat.us\",\"public\",\"unknown\"],\"q\":\"\",\"i\":false,\"f\":[[[\"\",{\"children\":[[ \"lang\", \"en-us\", \"d\", null],{\"children\":[[ \"url\", \"amplemarketstat.us\", \"d\", null],{\"children\":[[ \"type\", \"public\", \"d\", null],{\"children\":[[ \"userId\", \"unknown\", \"d\", null],{\"children\":[[ \"(site)\",{\"children\":[[ \"__PAGE__\",{} ]]},\"$undefined\",\"$undefined\",16 ]}]}\}}\}}\]],[[ \"$\",\"$1\",\"c\",{\"children\":[null,[ \"$\",\"$L2\",null,{\"parallelRouterKey\":\"children\",\"error\":\"$undefined\",\"errorStyles\":\"$undefined\",\"errorScripts\":\"$undefined\",\"template\":[ \"$\",\"$L3\",null,{} ],\"templateStyles\":\"$undefined\",\"templateScripts\":\"$undefined\",\"notFound\":[[[ \"$\", \"title\", null, { \"children\": \"404: This page could not be found.\" } ],[ \"$\", \"div\", null, { \"style\": { \"fontFamily\": \"system-ui,\\"Segoe UI\\",Roboto,Helvetica,Arial,sans-serif,\\"Apple Color Emoji\\\",\\"Segoe UI Emoji\\"\", \"height\": \"100vh\", \"textAlign\": \"center\", \"display\": \"flex\", \"flexDirection\": \"column\", \"alignItems\": \"center\", \"justifyContent\": \"center\" }, \"children\": [ [ \"$\", \"div\", null, { \"children\": [ [ \"$\", \"style\", null, { \"dangerouslySetInnerHTML\": { \"__html\": \"body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}\" } } ], [ \"$\", \"h1\", null, { \"className\": \"next-error-h1\", \"style\": { \"display\": \"inline-block\", \"margin\": \"0 20px 0 0\", \"padding\": \"0 23px 0 0\", \"fontSize\": 24, \"fontWeight\": 500, \"verticalAlign\": \"top\", \"lineHeight\": \"49px\" }, \"children\": 404 } ], [ \"$\", \"div\", null, { \"style\": { \"display\": \"inline-block\" }, \"children\": [ [ \"$\", \"h2\", null, { \"style\": { \"fontSize\": 14, \"fontWeight\": 400, \"lineHeight\": \"49px\", \"margin\": 0 }, \"children\": \"This page could not be found.\" } ] ] } ] ] } ] ] } ] ] } ] ] } ] }])
```

--------------------------------

### OpenAPI Specification for List Task Statuses

Source: https://docs.amplemarket.com/api-reference/tasks/get-tasks-statuses

This OpenAPI 3.0.1 specification defines the GET /tasks/statuses endpoint for listing task statuses. It includes server details, security schemes, and example responses.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /tasks/statuses:
    get:
      tags:
        - Tasks
      summary: List task statuses
      description: List task statuses
      parameters: []
      responses:
        '200': 
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    statuses:
                      - due
                      - upcoming
                      - completed
                      - skipped
                      - paused
                      - cancelled
              schema:
                type: object
                properties:
                  statuses:
                    type: array
                    items:
                      type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

--------------------------------

### OpenAPI Specification for Retrieve Contact

Source: https://docs.amplemarket.com/api-reference/contacts/get-contact

This OpenAPI 3.0.1 specification defines the GET /contacts/{id} endpoint for retrieving contact details. It includes path parameters, request/response schemas, and example responses.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /contacts/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Contact id
        schema:
          type: string
    get:
      tags:
        - Contacts
      summary: Retrieve contact
      description: Retrieve contact
      parameters: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    id: 019e927c-9e97-7492-b2a3-1768328a48c0
                    name: John Doe
                    first_name: John
                    last_name: Doe
                    linkedin_url: https://linkedin.com/in/john-doe
                    email: john.doe@example.com
                    time_zone: Europe/Lisbon
                    location: Lisbon, Lisbon, Portugal
                    title: Software Engineer
                    company_domain: amplemarket.com
                    company_name: Amplemarket
                    owner: user@example.com
                    last_contacted_at: '2026-06-02T11:55:01Z'
                    phone_numbers:
                      - id: 019e927c-9d6d-7f64-ae6d-7ff76750c148
                        object: phone_number
                        number: +1 639-300-0002
                        type: mobile
                        source: amplemarket
                        kind: mobile
                    recent_activity:
                      - event_at: '2026-06-04T11:55:00Z'
                        event_type: completed_without_reply
                        sequence_id: 156fb9424cdde63b32fc80dab2101359c66da185
                        sequence_type: sequence
                        sequence_name: A sequence
                      - event_at: '2026-06-03T10:43:00Z'
                        event_type: added_to_sequence
                        sequence_id: 156fb9424cdde63b32fc80dab2101359c66da185
                        sequence_type: sequence
                        sequence_name: A sequence
              schema:
                $ref: '#/components/schemas/response_contact_with_activity_object'
components:
  schemas:
    response_contact_with_activity_object:
      allOf:
        - $ref: '#/components/schemas/response_contact_object'
        - type: object
          additionalProperties: true
          properties:
            recent_activity:
              type: array
              items:
                $ref: '#/components/schemas/response_contact_activity_object'
    response_contact_object:
      type: object
      required:
        - id
        - email
      additionalProperties: true
      properties:
        id:
          type: string
          format: uuid
        name:
          nullable: true
          type: string
        first_name:
          nullable: true
          type: string
        last_name:
          nullable: true
          type: string
        email:
          nullable: true
          type: string
        linkedin_url:
          nullable: true
          type: string
          format: uri
        title:
          nullable: true
          type: string
        location:
          nullable: true
          type: string
        time_zone:
          nullable: true
          type: string
        company_name:
          nullable: true
          type: string
        company_domain:
          nullable: true
          type: string
        owner:
          nullable: true
          type: string
        last_contacted_at:
          type: string
          format: date_time
          nullable: true
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/response_phone_number_object'
    response_contact_activity_object:
      type: object
      required:
        - event_at
        - event_type
      additionalProperties: false
      properties:
        event_at:
          type: string
          format: date_time
        event_type:
          type: string
        automatic:
          nullable: true
          type: boolean
        type:
          nullable: true
          type: string
        description:
          nullable: true
          type: string
        subject:
          nullable: true
          type: string
        body:
          nullable: true
          type: string
        sequence_id:
          nullable: true
          type: string
        sequence_name:
          nullable: true
          type: string
        sequence_type:
          nullable: true
          type: string
        index:
          nullable: true

```

--------------------------------

### Creating a new Lead List

Source: https://docs.amplemarket.com/guides/lead-lists

Creates a new Lead List by supplying a list of leads and configuration options. The response indicates the list has been accepted for processing.

```APIDOC
## POST /lead-lists

### Description
Creates a new Lead List with a subset of settings. The list can be populated with leads of type `linkedin`, `email`, or `titles_and_company`.

### Method
POST

### Endpoint
/lead-lists

### Parameters
#### Request Body
- **owner** (string) - Required - Email of the owner of the lead list.
- **shared** (boolean) - Required - Indicates whether this list should be shared across the account.
- **type** (string) - Required - Type of the lead list. Supported types: `linkedin`, `email`, `titles_and_company`.
- **leads** (array of objects) - Required - An array of lead entries.
  - For `linkedin` type, each entry requires `linkedin_url`.
  - For `email` type, each entry requires `email`.
  - For `titles_and_company` type, each entry requires `title` and `company_name` (or `company_domain`).
- **name** (string) - Optional - Name of the lead list. Defaults to an automatically generated name.
- **visible** (boolean) - Optional - Defaults to true.
- **options** (object) - Optional - Configuration options for the lead list.
  - **reveal_phone_numbers** (boolean) - If phone numbers should be revealed.
  - **validate_email** (boolean) - If the emails of the leads should be validated. Can only be disabled for lists of type `email`.
  - **enrich** (boolean) - If the leads should be enriched. Can only be disabled for lists of type `email`.

### Request Example
```json
{
  "name": "Example",
  "shared": true,
  "visible": true,
  "owner": "user@example.com",
  "type": "linkedin",
  "leads": [
    {
      "linkedin_url": "..."
    },
    {
      "linkedin_url": "..."
    }
  ]
}
```

### Response
#### Success Response (202 Accepted)
- **id** (string) - The unique identifier for the lead list.
- **object** (string) - The type of object, which is `lead_list`.
- **name** (string) - The name of the lead list.
- **status** (string) - The current status of the lead list (e.g., `queued`, `processing`).
- **shared** (boolean) - Indicates if the list is shared.
- **visible** (boolean) - Indicates if the list is visible.
- **owner** (string) - The email of the owner.
- **type** (string) - The type of the lead list.
- **options** (object) - The configuration options for the lead list.
- **leads** (array) - An empty array, as leads are processed asynchronously.
- **_links** (object) - Links related to the lead list.
  - **self** (object) - Link to the lead list resource.
    - **href** (string) - The URL for the self link.

#### Response Example
```json
{
  "id": "81f63c2e-edbd-4c1a-9168-542ede3ce98f",
  "object": "lead_list",
  "name": "Example",
  "status": "queued",
  "shared": true,
  "visible": false,
  "owner": "user@example.com",
  "type": "linkedin",
  "options": {
    "reveal_phone_numbers": false,
    "validate_email": true,
    "enrich": true
  },
  "leads": [],
  "_links": {
    "self": { "href": "/lead-lists/81f63c2e-edbd-4c1a-9168-542ede3ce98f" }
  }
}
```

### Headers
- `Location`: `GET` points back to the object that was created.
```

--------------------------------

### OpenAPI Specification for Listing Task Types

Source: https://docs.amplemarket.com/api-reference/tasks/get-tasks-types

This OpenAPI 3.0.1 specification defines the GET /tasks/types endpoint for listing available task types. It includes server details, security schemes, and example responses.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /tasks/types:
    get:
      tags:
        - Tasks
      summary: List task types
      description: List task types
      parameters: []
      responses:
        '200': 
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    types:
                      - email
                      - linkedin_visit
                      - linkedin_follow
                      - linkedin_like_last_post
                      - linkedin_connect
                      - linkedin_message
                      - linkedin_voice_message
                      - linkedin_video_message
                      - phone_call
                      - custom_task
                      - whatsapp
                      - sms
              schema:
                type: object
                properties:
                  types:
                    type: array
                    items:
                      type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

--------------------------------

### List Accounts OpenAPI Specification

Source: https://docs.amplemarket.com/api-reference/accounts/get-accounts

This OpenAPI specification defines the GET /accounts endpoint for listing accounts. It includes parameters for filtering by name, domain, owner email, tags, and pagination, as well as example responses for successful requests and errors.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /accounts:
    get:
      tags:
        - Account
      summary: List Accounts
      description: List Accounts
      parameters:
        - name: name
          in: query
          required: false
          description: Filter accounts by name (case-insensitive partial match)
          schema:
            type: string
        - name: domain
          in: query
          required: false
          description: Filter accounts by domain (exact match)
          schema:
            type: string
        - name: owner_email
          in: query
          required: false
          description: Filter accounts by owner email (exact match)
          schema:
            type: string
        - name: tags[]
          in: query
          schema:
            type: array
            items:
              type: string
          required: false
          description: Filter accounts by tag names
        - name: page[after]
          in: query
          required: false
          description: Cursor for next page (from _links.next)
          schema:
            type: string
        - name: page[size]
          in: query
          required: false
          description: 'Page size (default: 10, max: 50)'
          schema:
            type: integer
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    accounts:
                      - id: pub_123
                        name: Acme Corp
                        website: acme.com
                        linkedin_url: https://linkedin.com/company/acme
                        owner_email: owner@example.com
                        last_contacted_at: null
                        last_engaged_at: null
                    _links:
                      self:
                        href: /accounts?page[size]=10
              schema:
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          nullable: true
                          type: string
                        website:
                          nullable: true
                          type: string
                        linkedin_url:
                          nullable: true
                          type: string
                        owner_email:
                          nullable: true
                          type: string
                        last_contacted_at:
                          type: string
                          format: date-time
                          nullable: true
                        last_engaged_at:
                          type: string
                          format: date-time
                          nullable: true
                  _links:
                    $ref: '#/components/schemas/response_links_object'
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                Invalid cursor:
                  value:
                    _errors:
                      - code: invalid_parameter
                        title: Invalid Parameter
                        detail: Invalid cursor
                    object: error
              schema:
                $ref: '#/components/schemas/response_errors_object'
components:
  schemas:
    response_links_object:
      type: object
      required:
        - self
      additionalProperties: false
      properties:
        self:
          $ref: '#/components/schemas/response_link_object'
        prev:
          $ref: '#/components/schemas/response_link_object'
        next:
          $ref: '#/components/schemas/response_link_object'
    response_errors_object:
      type: object
      required:
        - object
        - _errors
      additionalProperties: false
      properties:
        object:
          type: string
          enum:
            - error
        _errors:
          type: array
          items:
            $ref: '#/components/schemas/response_error_object'
        _links:
          $ref: '#/components/schemas/response_links_object'
    response_link_object:
      type: object
      required:
        - href
      additionalProperties: false
      properties:
        href:
          type: string
    response_error_object:
      type: object

```

--------------------------------

### Create Lead List

Source: https://docs.amplemarket.com/api-reference/lead-list/create-lead-list

Creates a new lead list with specified options and leads. The 'type' parameter determines the source of leads (e.g., 'linkedin').

```APIDOC
## POST /lead-lists

### Description
Creates a new lead list. You can specify the type of leads to collect (e.g., 'linkedin'), enrichment options, and provide a list of leads with their LinkedIn URLs.

### Method
POST

### Endpoint
/lead-lists

### Request Body
- **type** (string) - Required - The type of lead list (e.g., 'linkedin').
- **owner** (string) - Required - The owner of the lead list (email address).
- **options** (object) - Optional - Configuration options for the lead list.
  - **reveal_phone_numbers** (boolean) - Optional - Whether to reveal phone numbers.
  - **validate_email** (boolean) - Optional - Whether to validate email addresses.
  - **enrich** (boolean) - Optional - Whether to enrich lead data.
- **leads** (array) - Optional - A list of leads to include in the list. Each lead object should contain a `linkedin_url`.
  - **linkedin_url** (string) - Required - The LinkedIn URL of the lead.

### Request Example
```json
{
  "type": "linkedin",
  "owner": "user@example.com",
  "options": {
    "reveal_phone_numbers": false,
    "validate_email": true,
    "enrich": true
  },
  "leads": [
    {
      "linkedin_url": "https://www.linkedin.com/in/example/"
    }
  ]
}
```

### Response
#### Success Response (201 Created)
- **_links** (object) - Links related to the created lead list.
  - **self** (object) - Link to the created lead list.
    - **href** (string) - The URL of the lead list.
- **type** (string) - The type of the lead list.
- **created_at** (string) - Timestamp when the lead list was created.
- **updated_at** (string) - Timestamp when the lead list was last updated.
- **options** (object) - Configuration options for the lead list.
- **leads** (array) - The list of leads.

#### Response Example
```json
{
  "type": "linkedin",
  "created_at": "2026-06-04T11:54:44Z",
  "updated_at": "2026-06-04T11:54:44Z",
  "options": {
    "reveal_phone_numbers": false,
    "validate_email": true,
    "enrich": true
  },
  "leads": [],
  "_links": {
    "self": {
      "href": "/lead-lists/019e927c-5e08-7ac5-b91f-0576d30e8822"
    }
  }
}
```

### Error Handling
#### Bad Request (400)
- **Unsupported value (type)**: The provided 'type' is not supported.
- **Missing value (type)**: The 'type' field is missing.
- **Missing field (owner)**: The 'owner' field is missing.
- **Unsupported value (owner)**: The provided 'owner' email is invalid.
- **Missing field (leads)**: The 'leads' field is missing when required.
- **Unsupported value (leads over limit)**: The number of leads exceeds the 10,000 limit.
- **Unsupported value (lead with no LinkedIn URL)**: A lead object is missing the 'linkedin_url' field.
- **Unsupported value (lead with invalid LinkedIn URL)**: An invalid LinkedIn URL was provided for a lead.

#### Insufficient Credits (402)
- **Insufficient credits**: The user does not have enough credits to perform this operation.

#### Internal Server Error (500)
- **Internal server error**: An unexpected error occurred on the server.
```

--------------------------------

### OpenAPI Specification for Retrieve Person Enrichment Results

Source: https://docs.amplemarket.com/api-reference/people-enrichment/retrieve-enrichment-request-results

This OpenAPI 3.0.1 specification defines the GET /people/enrichment-requests/{id} endpoint for retrieving person enrichment results. It includes parameters for batch ID, pagination, and example responses for different request statuses.

```yaml
openapi: 3.0.1
info:
  title: Amplemarket API V1 Docs
  version: v1
servers:
  - url: https://api.amplemarket.com
security:
  - bearerAuth: []
paths:
  /people/enrichment-requests/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Batch id
        schema:
          type: string
      - name: page[size]
        in: query
        required: false
        description: Page size
        schema:
          type: string
      - name: page[after]
        in: query
        required: false
        description: Page after
        schema:
          type: string
      - name: page[before]
        in: query
        required: false
        description: Page before
        schema:
          type: string
    get:
      tags:
        - Person Enrichment
      summary: Retrieve person enrichment results
      description: Retrieve person enrichment results
      parameters: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                Processing:
                  value:
                    id: 11
                    object: person_enrichment
                    status: processing
                    results: []
                    _links:
                      self:
                        href: /people/enrichment-requests/11
                Completed:
                  value:
                    id: 12
                    object: person_enrichment
                    status: completed
                    results:
                      - linkedin_url: https://www.linkedin.com/in/test-linkedin-00d37bbc
                        id: 51
                        status: enriched
                        result:
                          id: 019e927c-5337-78c6-b0a5-ff3eb06c5bc7
                          object: person
                          name: Test Person
                          first_name: Test
                          last_name: Person
                          linkedin_url: https://www.linkedin.com/in/person-1
                          title: Sales Manager
                          current_position_start_date: '2022-05-01'
                          image_url: https://example.com/resource
                          location: San Francisco, California, United States
                          location_details:
                            city: San Francisco
                            state: California
                            country: United States
                          linkedin_presence: none
                          company:
                            id: 019e927c-531d-71f3-8184-c32eee635faa
                            object: company
                            name: Circle Health
                            linkedin_url: https://www.linkedin.com/company/company-1
                            keywords:
                              - Private healthcare
                            estimated_number_of_employees: 0
                            industry: Software Development
                            logo_url: >-
                              https://assets.amplemarket.com/avatars/company/019e927c-531d-71f3-8184-c32eee635faa
                            location: United States
                            location_details:
                              country: United States
                            overview: Circle Health is a group of hospitals in the UK
                            followers: 0
                            linkedin_presence: none
                            naics_codes:
                              - 5112
                              - 511
                              - 51
                          gender: unknown
                      - linkedin_url: https://www.linkedin.com/in/test-linkedin-f37261cb
                        id: 52
                        status: enriched
                        result:
                          id: 019e927c-5350-7816-96ca-86f17bbeffc3
                          object: person
                          name: Test Person
                          first_name: Test
                          last_name: Person
                          linkedin_url: https://www.linkedin.com/in/person-2
                          title: Sales Manager
                          current_position_start_date: '2022-05-01'
                          image_url: https://example.com/resource
                          location: San Francisco, California, United States
                          location_details:
                            city: San Francisco
                            state: California

```

--------------------------------

### Self Link Example

Source: https://docs.amplemarket.com/api-reference/pagination

Demonstrates the structure of a link object, specifically a 'self' link, which contains a relative URL.

```javascript
{
  "_links": {
    "self": { "href": "/email-validations/1" }
  }
}
```