### GET /admin/deal_stages

Source: https://app.pipelinecrm.com/docs

Lists all available deal stages.

```APIDOC
## GET /admin/deal_stages

### Description
Lists all available deal stages.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/deal_stages

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details
- **entries** (array) - List of deal stages
```

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

### GET /admin/product_lines

Source: https://app.pipelinecrm.com/docs

Lists all performance lanes available in the account.

```APIDOC
## GET /admin/product_lines

### Description
Retrieves a list of performance lanes. Requires Grow plan and admin API key.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/product_lines

### Response
#### Success Response (200)
- **entries** (array) - List of performance lanes

#### Response Example
{
  "entries": [
    {
      "id": 1,
      "name": "Remodeling",
      "enabled_for_deals": true,
      "enabled_for_people": true,
      "enabled_for_companies": true
    }
  ]
}
```

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

### GET /admin/webhooks

Source: https://app.pipelinecrm.com/docs

Retrieves a list of all configured webhooks.

```APIDOC
## GET /admin/webhooks

### Description
Returns a list of all active webhook subscriptions.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/webhooks

### Response
#### Success Response (200)
- **webhooks** (array) - List of webhook objects

#### Response Example
{
  "webhooks": [
    {
      "id": 1,
      "event_model": "deal",
      "event_action": "create",
      "url": "https://my.app.com/endpoint"
    }
  ]
}
```

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

### Web-to-Leads Configuration

Source: https://app.pipelinecrm.com/docs

Information regarding the setup and configuration of Web-to-Leads forms.

```APIDOC
## Web-to-Leads Setup

### Description
This section details the configuration parameters, attributes, and usage of Web-to-Leads forms for capturing leads.

### Topics Covered
- Setting up the form
- Configuration Parameters
- Lead/Contact Attributes
- Deal Attributes
- Company Attributes
- Calendar Attributes
- Using custom fields
- Using tags
- Using notes
- Notifications
- SSL
- Form Validation
- Lead Assignment
- A Simple Example
- A More Complex Example

*Specific API endpoints for Web-to-Leads configuration are not detailed in the provided text.*
```

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

### Retrieve Profile Response

Source: https://app.pipelinecrm.com/docs

Example response containing user profile information.

```json
{
  * "id": 1,
  * "first_name": "James",
  * "last_name": "Smith",
  * "avatar_thumb_url": "https://s3.amazonaws.com/pipelinedeals/avatars/1/thumb/wolverine-avatar.png",
  * "api_key": "jgQZGQ8SISLzUHmOI6v2",
  * "is_account_admin": true

}
```

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

### List and Create Searches

Source: https://app.pipelinecrm.com/docs

Examples for listing existing saved searches and the payload required to create a new one.

```json
[
  * {
    * "id": 1,
    * "search_type": "People",
    * "is_default": true,
    * "is_starred": false,
    * "is_shared": false,
    * "user_id": 1,
    * "sort": "-people.updated_at",
    * "name": "Super cool people search",
    * "query": {
      * "person_name": "James",
      * "person_email": "@acme.com"
},
    * "columns": [
      * "person_name",
      * "person_email"
]
}

]
```

```json
{
  * "search": {
    * "name": "Super cool people search",
    * "search_type": "People",
    * "query": {
      * "person_name": "James",
      * "person_email": "@acme.com"
},
    * "columns": [
      * "person_name",
      * "person_email"
]
}

}
```

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

### Customer Response Sample

Source: https://app.pipelinecrm.com/docs

Example JSON response for a successful customer retrieval request.

```json
{
  "id": 1,
  "created_at": "2020-02-07 15:26:10",
  "updated_at": "2020-02-07 15:26:10",
  "company_id": 1,
  "days_in_health": 36,
  "owner": {
    "id": 0,
    "full_name": "string"
},
  "health_score": "middle",
  "health_score_description": "Very positive engagement recently - relationship is improving!"

}
```

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

### Lead Status Response Sample

Source: https://app.pipelinecrm.com/docs

Example JSON response for a lead status object.

```json
{
  * "id": 1,
  * "created_at": "2020-02-07 15:26:10",
  * "updated_at": "2020-02-07 15:26:10",
  * "name": "In touch",
  * "hex_color": "9b9b9b"

}
```

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

### GET /admin/deal_loss_reasons

Source: https://app.pipelinecrm.com/docs

Retrieves a list of all deal loss reasons.

```APIDOC
## GET /admin/deal_loss_reasons

### Description
Retrieves a list of all deal loss reasons.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/deal_loss_reasons

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details
- **entries** (array) - List of deal loss reasons

#### Response Example
{
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 20,
    "total": 670
  },
  "entries": [
    {
      "id": 1,
      "created_at": "2020-02-07 15:26:10",
      "updated_at": "2020-02-07 15:26:10",
      "name": "Too Expensive",
      "position": 2
    }
  ]
}
```

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

### Project Association Response JSON

Source: https://app.pipelinecrm.com/docs

Example response structure for retrieving project associations.

```json
{
  * "entries": [
    * {
      * "id": 1,
      * "project_id": 10,
      * "associable_type": "Deal",
      * "associable_id": 123,
      * "created_at": "2026-01-15T10:30:00Z"
}
],
  * "pagination": {
    * "page": 0,
    * "per_page": 0,
    * "total": 0,
    * "total_pages": 0
}

}
```

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

### Calendar Entry Response Sample

Source: https://app.pipelinecrm.com/docs

Example JSON structure returned for a calendar entry.

```json
{
  * "id": 1,
  * "owner_id": 1,
  * "owner": {
    * "id": 1,
    * "full_name": "Bob Smith"
},
  * "category": {
    * "id": 1,
    * "name": "Phone call"
},
  * "completed_at": null,
  * "base_entry_id": 0,
  * "google_calendar_id": "string",
  * "part_of_recurring_series": true,
  * "recurrence_end": null,
  * "calendar_entry_priority": {
    * "id": 18,
    * "name": "High",
    * "hex_color": "ff0000",
    * "position": 1
},
  * "created_at": "2020-02-07 15:26:10",
  * "updated_at": "2020-02-07 15:26:10",
  * "type": "CalendarEvent",
  * "category_id": 1,
  * "name": "Call with Bob",
  * "description": "The meeting is at 3:30",
  * "start_time": "2012-06-13T11:47:15.000Z",
  * "end_time": "2012-06-13T11:47:15.000Z",
  * "all_day": true,
  * "due_date": "2025-01-01T00:00:00.000Z",
  * "complete": true,
  * "association_id": 1,
  * "association_type": "Deal",
  * "active": true,
  * "company_id": 1,
  * "rrule": "FREQ=WEEKLY;BYDAY=TU",
  * "rdate": "string",
  * "exrule": "string",
  * "exdate": "string",
  * "calendar_entry_priority_id": 1

}
```

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

### Note Category Response Sample

Source: https://app.pipelinecrm.com/docs

Example JSON response for a note category object.

```json
{
  * "id": 1,
  * "created_at": "2020-02-07 15:26:10",
  * "updated_at": "2020-02-07 15:26:10",
  * "name": "Call summary"

}
```

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

### Activity (Note) List Response

Source: https://app.pipelinecrm.com/docs

Example response structure for listing activities associated with a record.

```json
[
  {
    "id": 1,
    "account_id": 1,
    "possible_notify_user_ids": [
      1,
      2,
      3,
      4,
      5
],
    "is_sent_message": true,
    "primary_association_id": 1,
    "primary_association_type": "Deal",
    "user": {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "avatar_thumb_url": "string"
},
    "note_category": {
      "id": 0,
      "name": "string"
},
    "created_at": "2020-02-07 15:26:10",
    "updated_at": "2020-02-07 15:26:10",
    "user_id": 1,
    "title": "Appointment summary",
    "content": "This is the content",
    "deal_id": 1,
    "company_id": 1,
    "person_id": 1,
    "milestone_id": 0,
    "comments": { },
    "note_category_id": 1,
    "notify_user_ids": [
      1,
      2,
      3,
      4,
      5
]
}

]
```

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

### Search Query Condition Syntax

Source: https://app.pipelinecrm.com/docs

Example of how to structure query conditions for filtering list views.

```text
  "query" => {"deal_name" => "Cars", "deal_stage" => [123,124,125]}
```

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

### List Note Categories Response

Source: https://app.pipelinecrm.com/docs

Example JSON response containing a paginated list of note categories.

```json
{
  * "pagination": {
    * "page": 1,
    * "pages": 34,
    * "per_page": 20,
    * "total": 670
},
  * "entries": [
    * {
      * "id": 1,
      * "created_at": "2020-02-07 15:26:10",
      * "updated_at": "2020-02-07 15:26:10",
      * "name": "Call summary"
}
]

}
```

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

### Create Deal Example using curl

Source: https://app.pipelinecrm.com/docs

Demonstrates how to create a new deal using a POST request with JSON payload and specifies the Content-Type header. Requires authentication details to be added for actual use.

```bash
curl -H "Content-Type: application/json" \
  -X POST -d '{ "deal": { "name": "New Deal" } }' \
  "https://api.pipelinecrm.com/api/v3/deals.json"
```

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

### Retrieve Entity with Custom Fields

Source: https://app.pipelinecrm.com/docs

Example of a GET request and response structure for an entity containing custom fields.

```http
GET /people/1234.json
```

```json
{
  "id": 3,
  "first_name": "Veronika",
  "last_name": "Ajtai",
  ...
  "custom_fields": {
    "custom_label_90": 49,
    "custom_label_83": [ 28, 29, 30 ],
    "custom_label_89": "2012/05/21"
  },
  ...
}
```

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

### GET /admin/note_categories

Source: https://app.pipelinecrm.com/docs

Lists all note categories.

```APIDOC
## GET /admin/note_categories

### Description
Retrieves a paginated list of note categories.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/note_categories

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details
- **entries** (array) - List of note categories

#### Response Example
{
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 20,
    "total": 670
  },
  "entries": [
    {
      "id": 1,
      "created_at": "2020-02-07 15:26:10",
      "updated_at": "2020-02-07 15:26:10",
      "name": "Call summary"
    }
  ]
}
```

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

### Create Company API Endpoint Example

Source: https://app.pipelinecrm.com/docs

This URL demonstrates how to call the API to create a new company. It includes query parameters for duplicate checking and assignment email notifications. Replace placeholders with your actual API keys.

```url
https://api.pipelinecrm.com/api/companies.json?api_key=XXXXXXXXXXXXXXXXXXXXXXXXX&app_key=XXXXXXXXXXXXXXXXXXXXXXXXX&check_for_duplicates=true
```

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

### GET /api/v3/companies

Source: https://app.pipelinecrm.com/docs

Retrieves a list of companies.

```APIDOC
## GET /api/v3/companies

### Description
Retrieves a list of all companies.

### Method
GET

### Endpoint
/api/v3/companies

### Parameters
#### Query Parameters
- **conditions** (object) - Optional - Filtering conditions for companies.

### Response
#### Success Response (200)
Returns a list of company objects. The exact structure of the company object is not detailed in the provided text, but it would typically include fields like ID, name, etc.
```

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

### List Deal Stages Response

Source: https://app.pipelinecrm.com/docs

This sample response shows the structure for listing deal stages, including pagination and a list of stage entries.

```json
{
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 20,
    "total": 670
},
  "entries": [
    {
      "id": 1,
      "created_at": "2020-02-07 15:26:10",
      "updated_at": "2020-02-07 15:26:10",
      "name": "Proposal",
      "percent": 45,
      "deal_pipeline_id": 1
}
]

}
```

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

### GET /admin/predefined_contacts_tags

Source: https://app.pipelinecrm.com/docs

List all predefined contacts tags.

```APIDOC
## GET /admin/predefined_contacts_tags

### Description
List all predefined contacts tags available to be attached to People records.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/predefined_contacts_tags

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details
- **entries** (array) - List of tags
```

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

### GET /api/v3/calendar_entries

Source: https://app.pipelinecrm.com/docs

Retrieves a list of calendar entries.

```APIDOC
## GET /api/v3/calendar_entries

### Description
Retrieves a list of calendar entries.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/calendar_entries

### Responses
#### Success Response (200)
- **id** (integer) - Unique identifier for the calendar entry.
- **owner_id** (integer) - The ID of the user who owns the calendar entry.
- **owner** (object) - Information about the owner.
  - **id** (integer) - Owner's ID.
  - **full_name** (string) - Owner's full name.
- **category** (object) - Information about the category of the entry.
  - **id** (integer) - Category ID.
  - **name** (string) - Category name.
- **completed_at** (string) - Timestamp when the entry was completed, or null.
- **base_entry_id** (integer) - The ID of the base entry for recurring events.
- **google_calendar_id** (string) - The ID of the corresponding Google Calendar event.
- **part_of_recurring_series** (boolean) - Indicates if this entry is part of a recurring series.
- **recurrence_end** (string) - The end date for recurring events, or null.
- **calendar_entry_priority** (object) - Information about the priority of the entry.
  - **id** (integer) - Priority ID.
  - **name** (string) - Priority name (e.g., "High").
  - **hex_color** (string) - Hexadecimal color code for the priority.
  - **position** (integer) - The display order of the priority.
- **created_at** (string) - Timestamp when the entry was created.
- **updated_at** (string) - Timestamp when the entry was last updated.
- **type** (string) - The type of the calendar entry (e.g., "CalendarEvent").
- **category_id** (integer) - The ID of the category.
- **name** (string) - The name of the calendar entry.
- **description** (string) - A detailed description of the entry.
- **start_time** (string) - The start date and time of the entry.
- **end_time** (string) - The end date and time of the entry.
- **all_day** (boolean) - Indicates if the entry is an all-day event.
- **due_date** (string) - The due date for the entry.
- **complete** (boolean) - Indicates if the entry is completed.
- **association_id** (integer) - The ID of the associated record (e.g., Deal).
- **association_type** (string) - The type of the associated record (e.g., "Deal").
- **active** (boolean) - Indicates if the entry is active.
- **company_id** (integer) - The ID of the company associated with the entry.
- **rrule** (string) - Recurrence rule for the event.
- **rdate** (string) - Recurrence date.
- **exrule** (string) - Exception rule.
- **exdate** (string) - Exception date.
- **calendar_entry_priority_id** (integer) - The ID of the calendar entry priority.

#### Response Example
```json
[
  {
    "id": 1,
    "owner_id": 1,
    "owner": {
      "id": 1,
      "full_name": "Bob Smith"
    },
    "category": {
      "id": 1,
      "name": "Phone call"
    },
    "completed_at": null,
    "base_entry_id": 0,
    "google_calendar_id": "string",
    "part_of_recurring_series": true,
    "recurrence_end": null,
    "calendar_entry_priority": {
      "id": 18,
      "name": "High",
      "hex_color": "ff0000",
      "position": 1
    },
    "created_at": "2020-02-07 15:26:10",
    "updated_at": "2020-02-07 15:26:10",
    "type": "CalendarEvent",
    "category_id": 1,
    "name": "Call with Bob",
    "description": "The meeting is at 3:30",
    "start_time": "2012-06-13T11:47:15.000Z",
    "end_time": "2012-06-13T11:47:15.000Z",
    "all_day": true,
    "due_date": "2025-01-01T00:00:00.000Z",
    "complete": true,
    "association_id": 1,
    "association_type": "Deal",
    "active": true,
    "company_id": 1,
    "rrule": "FREQ=WEEKLY;BYDAY=TU",
    "rdate": "string",
    "exrule": "string",
    "exdate": "string",
    "calendar_entry_priority_id": 1
  }
]
```

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

### List Webhooks Response Sample

Source: https://app.pipelinecrm.com/docs

JSON structure returned when listing all configured webhooks.

```json
{
  * "webhooks": [
    * {
      * "id": 1,
      * "created_at": "2020-02-07 15:26:10",
      * "updated_at": "2020-02-07 15:26:10",
      * "name": "name",
      * "is_activated": true,
      * "account_id": 1,
      * "event_model": "deal",
      * "event_action": "create",
      * "url": "https://my.app.com/endpoint",
      * "failure_email": "fred@bedrock.com"
}
]

}
```

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

### GET /admin/person_custom_field_labels

Source: https://app.pipelinecrm.com/docs

Lists person custom field labels.

```APIDOC
## GET /admin/person_custom_field_labels

### Description
Lists person custom field labels.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/person_custom_field_labels

### Parameters
#### Query Parameters
- **conditions** (object) - Optional - CustomFieldLabelConditions

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details
- **entries** (array) - List of custom field labels
```

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

### POST /admin/product_lines

Source: https://app.pipelinecrm.com/docs

Creates a new performance lane.

```APIDOC
## POST /admin/product_lines

### Description
Creates a new performance lane. Requires Grow plan and admin API key.

### Method
POST

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/product_lines

### Parameters
#### Request Body
- **product_line** (object) - Required - ProductLineWritable object

### Request Example
{
  "product_line": {
    "name": "Remodeling",
    "enabled_for_deals": true
  }
}

### Response
#### Success Response (200)
- **id** (integer) - ID of created lane
- **name** (string) - Name of lane
- **enabled_for_deals** (boolean) - Deal status
```

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

### GET /admin/person_custom_field_groups

Source: https://app.pipelinecrm.com/docs

Lists all person custom field groups.

```APIDOC
## GET /admin/person_custom_field_groups

### Description
Retrieves a list of account-specific groupings of custom fields for People.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/person_custom_field_groups

### Response
#### Success Response (200)
- Successful Response
```

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

### GET /admin/deal_custom_field_groups

Source: https://app.pipelinecrm.com/docs

Lists all deal custom field groups.

```APIDOC
## GET /admin/deal_custom_field_groups

### Description
Lists all deal custom field groups.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/deal_custom_field_groups

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details.
- **entries** (array) - List of deal custom field groups.

#### Response Example
{
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 20,
    "total": 670
  },
  "entries": [
    {
      "id": 1,
      "created_at": "2020-02-07 15:26:10",
      "updated_at": "2020-02-07 15:26:10",
      "type": "CompanyCustomFieldGroup",
      "name": "Super cool group"
    }
  ]
}
```

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

### List Todo Templates Response Sample

Source: https://app.pipelinecrm.com/docs

A successful response when listing todo templates. It includes pagination details and a list of todo template entries.

```json
[
  {
    "pagination": {
      "page": 1,
      "pages": 34,
      "per_page": 20,
      "total": 670
    },
    "entries": [
      {
        "id": 1,
        "account_id": 123,
        "todo_template_items": [
          {
            "description": "Item 1",
            "days": 1,
            "event_category": {
              "id": 123,
              "name": "Category 1"
            }
          }
        ],
        "created_at": "2020-02-07 15:26:10",
        "updated_at": "2020-02-07 15:26:10",
        "name": "Super-awesome template",
        "template_type": "deals",
        "todo_template_types_attributes": [
          {
            "account_id": 123,
            "template_type": "deals"
          }
        ],
        "is_default": true
      }
    ]
  }

]
```

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

### GET /api/v3/notes/{id}

Source: https://app.pipelinecrm.com/docs

Retrieves a specific note by its ID.

```APIDOC
## Retrieve Note

### Description
Retrieves a specific note by its ID.

### Method
GET

### Endpoint
/api/v3/notes/{id}

### Path Parameters
- **id** (integer) - Required - The ID of the note to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the note.
- **account_id** (integer) - The ID of the account.
- **possible_notify_user_ids** (array) - List of possible user IDs for notification.
- **is_sent_message** (boolean) - Indicates if a message was sent.
- **primary_association_id** (integer) - The ID of the primary associated item.
- **primary_association_type** (string) - The type of the primary association (e.g., "Deal").
- **user** (object) - Information about the user who created the note.
  - **id** (integer) - User ID.
  - **first_name** (string) - User's first name.
  - **last_name** (string) - User's last name.
  - **avatar_thumb_url** (string) - URL for the user's avatar thumbnail.
- **note_category** (object) - Information about the note category.
  - **id** (integer) - Note category ID.
  - **name** (string) - Name of the note category.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
- **user_id** (integer) - The ID of the user who created the note.
- **title** (string) - The title of the note.
- **content** (string) - The main content of the note.
- **deal_id** (integer) - The ID of the associated deal.
- **company_id** (integer) - The ID of the associated company.
- **person_id** (integer) - The ID of the associated person.
- **milestone_id** (integer) - The ID of the associated milestone.
- **comments** (object) - A key-value object for comments.
- **note_category_id** (integer) - The ID of the note category.
- **notify_user_ids** (array) - An array of user IDs notified.

#### Response Example
```json
{
  "id": 1,
  "account_id": 1,
  "possible_notify_user_ids": [
    1,
    2,
    3,
    4,
    5
  ],
  "is_sent_message": true,
  "primary_association_id": 1,
  "primary_association_type": "Deal",
  "user": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "avatar_thumb_url": "string"
  },
  "note_category": {
    "id": 0,
    "name": "string"
  },
  "created_at": "2020-02-07 15:26:10",
  "updated_at": "2020-02-07 15:26:10",
  "user_id": 1,
  "title": "Appointment summary",
  "content": "This is the content",
  "deal_id": 1,
  "company_id": 1,
  "person_id": 1,
  "milestone_id": 0,
  "comments": { },
  "note_category_id": 1,
  "notify_user_ids": [
    1,
    2,
    3,
    4,
    5
  ]
}
```
```

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

### List Deal Loss Reasons Response

Source: https://app.pipelinecrm.com/docs

This sample response shows the structure for listing deal loss reasons, including pagination details and a list of entries.

```json
{
  "pagination": {
    "page": 1,
    "pages": 34,
    "per_page": 20,
    "total": 670
},
  "entries": [
    {
      "id": 1,
      "created_at": "2020-02-07 15:26:10",
      "updated_at": "2020-02-07 15:26:10",
      "name": "Too Expensive",
      "position": 2
}
]

}
```

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

### Create Deal Loss Reason Response

Source: https://app.pipelinecrm.com/docs

This sample response indicates a successful creation of a deal loss reason, returning the created object's details.

```json
{
  "id": 1,
  "created_at": "2020-02-07 15:26:10",
  "updated_at": "2020-02-07 15:26:10",
  "name": "Too Expensive",
  "position": 2

}
```

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

### GET /admin/revenue_types/{id}

Source: https://app.pipelinecrm.com/docs

Retrieves a specific revenue type by ID.

```APIDOC
## GET /admin/revenue_types/{id}

### Description
Retrieves details for a specific revenue type.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/revenue_types/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Revenue type ID (>= 1)

### Response
#### Success Response (200)
- **id** (integer) - Revenue type ID
- **name** (string) - Revenue type name
```

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

### POST /admin/deal_stages

Source: https://app.pipelinecrm.com/docs

Creates a new deal stage.

```APIDOC
## POST /admin/deal_stages

### Description
Creates a new deal stage.

### Method
POST

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/deal_stages

### Parameters
#### Request Body
- **deal_stage** (object) - Required - DealStageWritable object
```

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

### GET /admin/revenue_types

Source: https://app.pipelinecrm.com/docs

Lists all revenue types available for Deal records.

```APIDOC
## GET /admin/revenue_types

### Description
Retrieves a list of revenue types. Can be read by non-admins.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/admin/revenue_types

### Response
#### Success Response (200)
- **revenue_types** (array) - List of revenue type objects
```

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

### GET /api/v3/searches/{id}

Source: https://app.pipelinecrm.com/docs

Retrieves a specific search configuration by its ID.

```APIDOC
## Retrieve search

### Description
Retrieves a specific search configuration by its ID.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/searches/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Search ID (>= 1)

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the search.
- **search_type** (string) - The type of search (e.g., "People").
- **is_default** (boolean) - Indicates if this is the default search.
- **is_starred** (boolean) - Indicates if the search is starred.
- **is_shared** (boolean) - Indicates if the search is shared.
- **user_id** (integer) - The ID of the user who created the search.
- **sort** (string) - The sorting order for the search results.
- **name** (string) - The name of the search.
- **query** (object) - The search query parameters.
  - **person_name** (string) - Filters by person's name.
  - **person_email** (string) - Filters by person's email.
- **columns** (array) - The columns to be displayed in the search results.
  - (string) - The name of a column.

### Response Example
```json
{
  "id": 1,
  "search_type": "People",
  "is_default": true,
  "is_starred": false,
  "is_shared": false,
  "user_id": 1,
  "sort": "-people.updated_at",
  "name": "Super cool people search",
  "query": {
    "person_name": "James",
    "person_email": "@acme.com"
  },
  "columns": [
    "person_name",
    "person_email"
  ]
}
```
```

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

### GET /api/v3/documents/{id}

Source: https://app.pipelinecrm.com/docs

Retrieve the details of a specific document by its ID.

```APIDOC
## GET /api/v3/documents/{id}

### Description
Retrieve the details of a specific document by its ID.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/documents/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - File (document) ID

### Response
#### Success Response (200)
- **id** (integer) - Document ID
- **created_at** (string) - Creation timestamp
- **size_in_k** (integer) - File size in KB
- **owner** (object) - Owner details
- **person** (object) - Associated person details
- **deal** (object) - Associated deal details
- **company** (object) - Associated company details
- **etag** (string) - ETag for caching
- **upload_status** (integer) - Status code of the upload
- **upload_status_error_message** (string) - Error message if upload failed
- **upload_state** (string) - Current state of the upload
- **document_tag_ids** (array) - List of associated tag IDs
- **document_tags** (object) - Tag details
- **public_link** (string) - Public URL for the document
- **updated_at** (string) - Last update timestamp
- **title** (string) - Document title
- **owner_id** (integer) - Owner ID
- **person_id** (integer) - Person ID
- **deal_id** (integer) - Deal ID
- **company_id** (integer) - Company ID
- **url** (string) - Document URL

#### Response Example
{
  "id": 1,
  "created_at": "2020-02-07 15:26:10",
  "size_in_k": 102,
  "owner": { "id": 0, "full_name": "string" },
  "person": { "id": 0, "full_name": "string" },
  "deal": { "id": 0, "name": "string" },
  "company": { "id": 0, "name": "string" },
  "etag": "edd88e4bfa45c14de553c40d17c8f504",
  "upload_status": 1,
  "upload_status_error_message": "The server returned 404 Not Found",
  "upload_state": "pending",
  "document_tag_ids": [123, 124],
  "document_tags": { "id": 0, "name": null },
  "public_link": "https://pipelinedeals.s3.amazonaws.com/document.txt",
  "updated_at": "2020-02-07 15:26:10",
  "title": "Screenshot.png",
  "owner_id": 123,
  "person_id": 123,
  "deal_id": 123,
  "company_id": 123,
  "url": "string"
}
```

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

### GET /api/v3/documents

Source: https://app.pipelinecrm.com/docs

Retrieves a list of files (documents) associated with the account.

```APIDOC
## GET /api/v3/documents

### Description
Lists all files (documents) available in the system.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/documents

### Parameters
#### Query Parameters
- **sort** (string) - Optional - The attribute to sort on
- **conditions** (object) - Optional - DocumentConditions object

### Response
#### Success Response (200)
- Returns an array of document objects.

#### Response Example
[
  {
    "id": 1,
    "title": "Screenshot.png",
    "public_link": "https://pipelinedeals.s3.amazonaws.com/document.txt",
    "upload_state": "pending"
  }
]
```

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

### GET /api/v3/companies/{id}

Source: https://app.pipelinecrm.com/docs

Retrieve a single company record by its ID.

```APIDOC
## GET /api/v3/companies/{id}

### Description
Retrieve a single company record by its unique identifier.

### Method
GET

### Endpoint
https://api.pipelinecrm.com/api/v3/companies/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Company ID (>= 1)

### Response
#### Success Response (200)
- **id** (integer) - Company ID
- **name** (string) - Company name
- **description** (string) - Company description
- **email** (string) - Contact email

#### Response Example
{
  "id": 1,
  "name": "My company",
  "description": "string",
  "email": "info@contact.com"
}
```

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

### Create Todo Template Response Sample

Source: https://app.pipelinecrm.com/docs

A successful response after creating a todo template. It returns the newly created template with its assigned ID and other details.

```json
{
  "id": 1,
  "account_id": 123,
  "todo_template_items": [
    {
      "description": "Item 1",
      "days": 1,
      "event_category": {
        "id": 123,
        "name": "Category 1"
      }
    }
  ],
  "created_at": "2020-02-07 15:26:10",
  "updated_at": "2020-02-07 15:26:10",
  "name": "Super-awesome template",
  "template_type": "deals",
  "todo_template_types_attributes": [
    {
      "account_id": 123,
      "template_type": "deals"
    }
  ],
  "is_default": true

}
```

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

### 200 OK Response Sample for Deals

Source: https://app.pipelinecrm.com/docs

This JSON object represents a successful response when retrieving deal information. It includes detailed fields for a deal, its owner, contacts, company, and associated data.

```json
[{
  "id": 1,
  "owner": {
    "id": 0,
    "full_name": "string"
},
    "import_id": 1,
    "expected_close_date_event_id": 1,
    "primary_contact": {
      "id": 0,
      "full_name": "string"
},
    "people": [
      { }
],
    "collaborators": [
      { }
],
    "company": {
      "id": 0,
      "name": "string"
},
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$"
},
    "deal_stage": {
      "id": 1,
      "name": "Proposal"
},
    "deal_loss_reason": {
      "id": 1,
      "name": "Price"
},
    "source": {
      "id": 1,
      "name": "Organic Traffic"
},
    "possible_notify_user_ids": [
      1,
      2,
      3,
      4,
      5
],
    "next_task_name": "Introductory call",
    "next_task_id": 1,
    "next_task_due": "2023/03/17",
    "next_task_all_day": false,
    "tags": [
      {
        "id": 0,
        "name": "string"
}
],
    "created_at": "2020-02-07 15:26:10",
    "updated_at": "2020-02-07 15:26:10",
    "name": "My deal",
    "summary": "Super lucrative deal",
    "user_id": 1,
    "status": 1,
    "expected_close_date": "2020-02-02T00:00:00.000Z",
    "closed_time": "2020-03-01T00:00:00.000Z",
    "is_archived": false,
    "value": 1255.23,
    "primary_contact_id": 1,
    "person_ids": [
      1,
      2,
      3
],
    "shared_user_ids": [
      1,
      2,
      3
],
    "company_id": 1,
    "company_name": "Acme Inc.",
    "probability": 75,
    "deal_stage_id": 1,
    "deal_loss_reason_id": 1,
    "deal_loss_reason_notes": "Too expensive",
    "deal_won_reason_id": 1,
    "deal_won_reason_notes": "Great value for the price",
    "deal_source": 1,
    "custom_fields": {
      "custom_label_90": [
        45,
        46,
        47
],
      "custom_label_5": "text val"
},
    "tag_ids": [
      3,
      4,
      5
],
    "address_1": "123 Main St.",
    "address_2": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "USA"
}

]
```