openapi: 3.0.0
servers:
  - url: https://api.salesloft.com
info:
  contact:
    email: integrations@salesloft.com
    x-twitter: SalesLoft
  description: |
    SalesLoft helps transform sales teams into modern sales organizations  - converting more target accounts into customer accounts
  title: SalesLoft Platform
  version: v2
  x-apisguru-categories:
    - customer_relation
  x-logo:
    url: https://twitter.com/SalesLoft/profile_image?size=original
  x-origin:
    - format: openapi
      url: https://developers.salesloft.com/v2_api_def.json
      version: "3.0"
  x-providerName: salesloft.com
tags:
  - description: User Information
    name: Me
  - description: Team Information
    name: Team
  - description: Account Management
    name: Accounts
  - description: Account Stage Management
    name: Account Stages
  - description: Account Tier Information
    name: Account Tiers
  - description: Account Upsert
    name: Account Upsert
  - description: Actions
    name: Actions
  - description: Actions - Call Instructions
    name: Action Details - Call Instructions
  - description: Activities
    name: Activities
  - description: Activity Histories
    name: Activity Histories
  - description: Bulk Jobs
    name: Bulk Jobs
  - description: Bulk Jobs - Job Data
    name: Bulk Jobs - Job Data
  - description: Bulk Jobs - Results
    name: Bulk Jobs - Results
  - description: Cadence Exports
    name: Cadence Exports
  - description: Cadence Importing
    name: Cadence Imports
  - description: Cadence Management
    name: Cadences
  - description: Cadence Membership
    name: Cadence Memberships
  - description: Calendar Events
    name: Calendar Events
  - description: Call Data Record Management
    name: Call Data Records
  - description: Call Dispositions
    name: Call Dispositions
  - description: Call Management
    name: Calls
  - description: Call Sentiments
    name: Call Sentiments
  - description: Caller ID Information
    name: Caller IDs
  - description: Conversations Calls
    name: Conversations Calls
  - description: CRM Activity Fields
    name: CRM Activity Fields
  - description: CRM Activity Management
    name: CRM Activities
  - description: Crm Users
    name: Crm Users
  - description: Custom Field Management
    name: Custom Fields
  - description: Email Management
    name: Emails
  - description: Email Template Attachments
    name: Email Template Attachments
  - description: Email Templates Management
    name: Email Templates
  - description: External Emails
    name: External Emails
  - description: Group Management
    name: Groups
  - description: Import Management
    name: Imports
  - description: Live Feed Items
    name: Live Feed Items
  - description: Live Website Tracking Parameters
    name: Live Website Tracking Parameters
  - description: Meetings
    name: Meetings
  - description: Meetings Settings
    name: Meeting Settings
  - description: Meetings Settings - Searches
    name: Meetings Settings - Searches
  - description: MIME content for email
    name: Mime Email Payloads
  - description: Note Management
    name: Notes
  - description: Ongoing Actions
    name: Ongoing Actions
  - description: Pending Emails
    name: Pending Emails
  - description: Person Management
    name: People
  - description: Person Stage Management
    name: Person Stages
  - description: Person Upsert
    name: Person Upsert
  - description: Phone Number Assignments
    name: Phone Number Assignments
  - description: Recording Settings Information
    name: Recording Settings
  - description: Role Information
    name: Roles
  - description: Saved List Views
    name: Saved List Views
  - description: Steps
    name: Steps
  - description: Success Management
    name: Successes
  - description: Tags
    name: Tags
  - description: Tasks
    name: Tasks
  - description: Team Template Attachments
    name: Team Template Attachments
  - description: Team Template Management
    name: Team Templates
  - description: User Management
    name: Users
  - description: Webhook Subscriptions
    name: Webhook Subscriptions
paths:
  /v2/account_stages.json:
    get:
      description: |
        Fetches multiple account stage records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of account stages to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at, order. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/AccountStage"
                type: array
          description: Success
      summary: List account stages
      tags:
        - Account Stages
  "/v2/account_stages/{id}.json":
    get:
      description: |
        Fetches an account stage, by ID only.
      parameters:
        - description: Account Stage ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/AccountStage"
          description: Success
      summary: Fetch an account stage
      tags:
        - Account Stages
  /v2/account_tiers.json:
    get:
      description: |
        Fetches multiple account tier records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of Account Tiers to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters Account Tiers by name. Multiple names can be applied
          explode: false
          in: query
          name: name
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at, order. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/AccountTier"
                type: array
          description: Success
      summary: List Account Tiers
      tags:
        - Account Tiers
  "/v2/account_tiers/{id}.json":
    get:
      description: |
        Fetches an account tier, by ID only.
      parameters:
        - description: Account Tier ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/AccountTier"
          description: Success
      summary: Fetch an account tier
      tags:
        - Account Tiers
  /v2/account_upserts.json:
    post:
      description: |
        Upserts an account record. The upsert_key dictates how the upsert will be performed. The create and update behavior
        is exactly the same as the individual create and update endpoints.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_tier_id:
                  description: ID of the Account Tier for this Account
                  type: integer
                city:
                  description: City
                  type: string
                company_stage_id:
                  description: ID of the CompanyStage assigned to this Account
                  type: integer
                company_type:
                  description: Type of the Account's company
                  type: string
                conversational_name:
                  description: Conversational name of the Account
                  type: string
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either an Account (001) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "account:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  items:
                    type: object
                  type: array
                description:
                  description: Description
                  type: string
                do_not_contact:
                  description: Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications
                  type: boolean
                domain:
                  description: Website domain, not a fully qualified URI
                  type: string
                founded:
                  description: Date or year of founding
                  type: string
                id:
                  description: |
                    ID of the account to update. Used if the upsert_key=id. When id and another upsert_key are provided,
                    the request will fail if the upsert record id and id parameter don't match.
                  type: integer
                industry:
                  description: Industry
                  type: string
                linkedin_url:
                  description: Full LinkedIn url
                  type: string
                locale:
                  description: Time locale
                  type: string
                name:
                  description: Account Full Name
                  type: string
                owner_id:
                  description: ID of the User that owns this Account
                  type: integer
                phone:
                  description: Phone number without formatting
                  type: string
                postal_code:
                  description: Postal code
                  type: string
                revenue_range:
                  description: Estimated revenue range
                  type: string
                size:
                  description: Estimated number of people in employment
                  type: string
                state:
                  description: State
                  type: string
                street:
                  description: Street name and number
                  type: string
                tags:
                  description: All tags applied to this Account
                  items:
                    type: string
                  type: array
                twitter_handle:
                  description: Twitter handle, with @
                  type: string
                upsert_key:
                  description: |
                    Name of the parameter to upsert on. The field must be provided in the input parameters, or the request will fail.
                    The request will also fail if there are multiple records matched by the upsert field.

                    If upsert_key is not provided, this endpoint will not update an existing record.

                    Valid options are: id, crm_id, domain. If crm_id is provided, then a valid crm_id_type must be provided, as documented
                    for the account create and update endpoints.
                  type: string
                website:
                  description: Website
                  type: string
              required:
                - name
                - domain
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/AccountUpsert"
          description: Success
      summary: Upsert an account
      tags:
        - Account Upsert
  /v2/accounts.json:
    get:
      description: |
        Fetches multiple account records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of accounts to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters accounts by crm_id. Multiple crm ids can be applied
          explode: false
          in: query
          name: crm_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by the tags applied to the account. Multiple tags can be applied
          explode: false
          in: query
          name: tag
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by the tag id's applied to the account. Multiple tag id's can be applied
          explode: false
          in: query
          name: tag_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: created_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Domain of the accounts to fetch. Domains are unique and lowercase
          in: query
          name: domain
          required: false
          schema:
            type: string
        - description: Filters accounts by website. Multiple websites can be applied. An additional value of "_is_null" can be passed to filter accounts that do not have a website.
          explode: false
          in: query
          name: website
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by archived_at status. Returns only accounts where archived_at is not null if this field is true. Returns only accounts where archived_at is null if this field is false. Do not pass this parameter to return both archived and unarchived accounts. This filter is not applied if any value other than "true" or "false" is passed.
          in: query
          name: archived
          required: false
          schema:
            type: boolean
        - description: Names of accounts to fetch. Name matches are exact and case sensitive. Multiple names can be fetched.
          explode: false
          in: query
          name: name
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by account_stage_id. Multiple account_stage_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that do not have account_stage_id
          explode: false
          in: query
          name: account_stage_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters accounts by account_tier_id. Multiple account tier ids can be applied
          explode: false
          in: query
          name: account_tier_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters accounts by owner_id. Multiple owner_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that are unowned
          explode: false
          in: query
          name: owner_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by whether the owner is active or not.
          in: query
          name: owner_is_active
          required: false
          schema:
            type: boolean
        - description: |
            Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range.
            Additional values of "_is_null" or "_is_not_null" can be passed to filter records that either have no timestamp value or any timestamp value.
            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          in: query
          name: last_contacted
          required: false
          schema:
            type: object
        - description: "Filters by accounts matching all given custom fields. The custom field names are case-sensitive, but the provided values are case-insensitive. Example: v2/accounts?custom_fields[custom_field_name]=custom_field_value"
          in: query
          name: custom_fields
          required: false
          schema:
            type: object
        - description: Filters accounts by industry by exact match. Supports partial matching
          explode: false
          in: query
          name: industry
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by country by exact match. Supports partial matching
          explode: false
          in: query
          name: country
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by state by exact match. Supports partial matching
          explode: false
          in: query
          name: state
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by city by exact match. Supports partial matching
          explode: false
          in: query
          name: city
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: 'Filters accounts by owner_crm_id. Multiple owner_crm_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that are unowned. A "_not_in" modifier can be used to exclude specific owner_crm_ids. Example: v2/accounts?owner_crm_id[_not_in]=id'
          explode: false
          in: query
          name: owner_crm_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters accounts by locale. Multiple locales are allowed
          explode: false
          in: query
          name: locales
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values. Example: v2/accounts?user_relationships[name]=value"
          in: query
          name: user_relationships
          required: false
          schema:
            type: object
        - description: "Key to sort on, must be one of: created_at, updated_at, last_contacted_at, account_stage, account_stage_name, account_tier, account_tier_name, name, counts_people. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Account"
                type: array
          description: Success
      summary: List accounts
      tags:
        - Accounts
    post:
      description: |
        Creates an account.

        "domain" must be unique on the current team.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_tier_id:
                  description: ID of the Account Tier for this Account
                  type: integer
                city:
                  description: City
                  type: string
                company_stage_id:
                  description: ID of the CompanyStage assigned to this Account
                  type: integer
                company_type:
                  description: Type of the Account's company
                  type: string
                conversational_name:
                  description: Conversational name of the Account
                  type: string
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either an Account (001) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "account:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  items:
                    type: object
                  type: array
                description:
                  description: Description
                  type: string
                do_not_contact:
                  description: Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications
                  type: boolean
                domain:
                  description: Website domain, not a fully qualified URI
                  type: string
                founded:
                  description: Date or year of founding
                  type: string
                industry:
                  description: Industry
                  type: string
                linkedin_url:
                  description: Full LinkedIn url
                  type: string
                locale:
                  description: Time locale
                  type: string
                name:
                  description: Account Full Name
                  type: string
                owner_id:
                  description: ID of the User that owns this Account
                  type: integer
                phone:
                  description: Phone number without formatting
                  type: string
                postal_code:
                  description: Postal code
                  type: string
                revenue_range:
                  description: Estimated revenue range
                  type: string
                size:
                  description: Estimated number of people in employment
                  type: string
                state:
                  description: State
                  type: string
                street:
                  description: Street name and number
                  type: string
                tags:
                  description: All tags applied to this Account
                  items:
                    type: string
                  type: array
                twitter_handle:
                  description: Twitter handle, with @
                  type: string
                website:
                  description: Website
                  type: string
              required:
                - name
                - domain
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Account"
          description: Success
      summary: Create an account
      tags:
        - Accounts
  "/v2/accounts/{id}.json":
    delete:
      description: |
        Deletes an account. This operation is not reversible without contacting support.
        This operation can be called multiple times successfully.

        Deleting an account will remove all connected people from that account.
      parameters:
        - description: Account ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The Account has been deleted successfully
      summary: Delete an account
      tags:
        - Accounts
    get:
      description: |
        Fetches an account, by ID only.
      parameters:
        - description: Account ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Account"
          description: Success
      summary: Fetch an account
      tags:
        - Accounts
    put:
      description: |
        Updates an account.

        "domain" must be unique on the current team.
      parameters:
        - description: Account ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_tier_id:
                  description: ID of the Account Tier for this Account
                  type: integer
                archived:
                  description: Whether this Account should be archived or not. Setting this to true sets archived_at to the current time if it's not already set. Setting this to false will set archived_at to null
                  type: boolean
                city:
                  description: City
                  type: string
                company_stage_id:
                  description: ID of the CompanyStage assigned to this Account
                  type: integer
                company_type:
                  description: Type of the Account's company
                  type: string
                conversational_name:
                  description: Conversational name of the Account
                  type: string
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either an Account (001) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "account:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  items:
                    type: object
                  type: array
                description:
                  description: Description
                  type: string
                do_not_contact:
                  description: Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications
                  type: boolean
                domain:
                  description: Website domain, not a fully qualified URI
                  type: string
                founded:
                  description: Date or year of founding
                  type: string
                industry:
                  description: Industry
                  type: string
                linkedin_url:
                  description: Full LinkedIn url
                  type: string
                locale:
                  description: Time locale
                  type: string
                name:
                  description: Account Full Name
                  type: string
                owner_id:
                  description: ID of the User that owns this Account
                  type: integer
                phone:
                  description: Phone number without formatting
                  type: string
                postal_code:
                  description: Postal code
                  type: string
                revenue_range:
                  description: Estimated revenue range
                  type: string
                size:
                  description: Estimated number of people in employment
                  type: string
                state:
                  description: State
                  type: string
                street:
                  description: Street name and number
                  type: string
                tags:
                  description: All tags applied to this Account
                  items:
                    type: string
                  type: array
                twitter_handle:
                  description: Twitter handle, with @
                  type: string
                website:
                  description: Website
                  type: string
              required:
                - name
                - domain
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Account"
          description: Success
      summary: Update an existing Account
      tags:
        - Accounts
  /v2/action_details/call_instructions.json:
    get:
      description: |
        Fetches multiple call instruction records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of call instructions to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CallInstruction"
                type: array
          description: Success
      summary: List call instructions
      tags:
        - Action Details - Call Instructions
  "/v2/action_details/call_instructions/{id}.json":
    get:
      description: |
        Fetches a call instruction, by ID only.
      parameters:
        - description: Call instructions ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CallInstruction"
          description: Success
      summary: Fetch a call instructions
      tags:
        - Action Details - Call Instructions
  /v2/actions.json:
    get:
      description: |
        Fetches multiple action records. The records can be filtered, paged, and sorted according to
        the respective parameters. Only actions that are currently "in_progess" will be returned by
        this endpoint.

        If the requester is not an admin, this endpoint will only return actions belonging to the requester.
        If the request is an admin, this endpoint will return actions for the entire team. Additionaly, an admin
        may use the user_guid parameter to request actions that belong to specific users on the team.
      parameters:
        - description: IDs of actions to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Fetch actions by step ID
          in: query
          name: step_id
          required: false
          schema:
            type: integer
        - description: Filter actions by type
          in: query
          name: type
          required: false
          schema:
            type: string
        - description: |
            Equality filters that are applied to the due_on field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: due_on
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters actions by the user's guid. Multiple user guids can be applied. The user must be a team admin to filter other users' actions
          explode: false
          in: query
          name: user_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters actions by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters actions by cadence_id. Multiple cadence ids can be applied
          explode: false
          in: query
          name: cadence_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters actions by multitouch_group_id. Multiple multitouch group ids can be applied
          explode: false
          in: query
          name: multitouch_group_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Action"
                type: array
          description: Success
      summary: List actions
      tags:
        - Actions
  "/v2/actions/{id}.json":
    get:
      description: |
        Fetches an action, by ID only.
        This endpoint will only return actions that are in_progress or pending_activity.
        Once an action is complete, the request for that action will return a 404 status code.
      parameters:
        - description: Action ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Action"
          description: Success
      summary: Fetch an action
      tags:
        - Actions
  /v2/activities.json:
    post:
      description: |
        Creates an activity. An activity will mark the associated action as completed. Currently,
        only certain action types can have an activity explicitly created for them.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                action_id:
                  description: |
                    Action that is being completed. This will validate that the action is still
                    valid before completed it. The same action can never be successfully passed twice to this endpoint.
                    The action must have a type of 'integration'.
                  type: integer
                task_id:
                  description: |
                    Task that is being completed. This will validate that the task is still
                    valid before completed it. The same action can never be successfully passed twice to this endpoint.
                    The task must have a type of 'integration'.
                  type: integer
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Activity"
          description: Success
      summary: Create an activity
      tags:
        - Activities
  /v2/activities/calls.json:
    get:
      description: |
        Fetches multiple call records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of calls to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: created_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters list to only include guids
          explode: false
          in: query
          name: user_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters calls by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters calls by sentiment. Sentiment matches are exact and case sensitive. Multiple sentiments are allowed.
          explode: false
          in: query
          name: sentiment
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters calls by disposition. Disposition matches are exact and case sensitive. Multiple dispositions are allowed.
          explode: false
          in: query
          name: disposition
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Call"
                type: array
          description: Success
      summary: List calls
      tags:
        - Calls
    post:
      description: |
        Creates a call. The parameters of this endpoint can be used to create an action
        and ensure that the CRM Task is mapped correctly.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                action_id:
                  description: |
                    Action that this call is being logged for. This will validate that the action is still
                    valid before completing it. The same action can never be successfully passed twice to this endpoint. The
                    action must have a type of 'phone'.
                  type: integer
                crm_params:
                  description: |
                    CRM specific parameters. Some parameters are required on a per-team basis. Consume the
                    CrmActivityFields endpoint to receive a list of valid parameters. The "field" property
                    is passed as the key of this object, and the value of this object is the value that you
                    would like to set.

                    If CrmActivityField has a non-null value, then that value must be submitted, or excluded
                    from API calls, as these values are automatically applied.
                  type: object
                disposition:
                  description: The disposition of the call. Can be required on a per-team basis. Must be present in the disposition list.
                  type: string
                duration:
                  description: The length of the call, in seconds
                  type: integer
                linked_call_data_record_ids:
                  description: |
                    CallDataRecord associations that will become linked to the created call. It is possible to pass
                    multiple CallDataRecord ids in this field; this can be used to represent multiple phone calls
                    that made up a single call.

                    Any call data record that is used must not already be linked to a call. It is not possible
                    to link a call data record to multiple calls, and it is not possible to re-assign a call data
                    record to a different call.
                  items:
                    type: integer
                  type: array
                notes:
                  description: Notes to log for the call. This is similar to the notes endpoint, but ensures that the notes get synced to the user's CRM
                  type: string
                person_id:
                  description: The ID of the person whom this call will be logged for
                  type: integer
                sentiment:
                  description: The sentiment of the call. Can be required on a per-team basis. Must be present in the sentiment list.
                  type: string
                to:
                  description: The phone number that was called
                  type: string
                user_guid:
                  description: Guid of the user whom this call should be logged for. Defaults to the authenticated user. Only team admins can pass another user's guid
                  type: string
              required:
                - person_id
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Call"
          description: Success
      summary: Create a call
      tags:
        - Calls
  "/v2/activities/calls/{id}.json":
    get:
      description: |
        Fetches a call, by ID only.
      parameters:
        - description: Call ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Call"
          description: Success
      summary: Fetch a call
      tags:
        - Calls
  /v2/activities/emails.json:
    get:
      description: |
        Fetches multiple email records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters emails by whether they have bounced or not
          in: query
          name: bounced
          required: false
          schema:
            type: boolean
        - description: Filters emails by crm_activity_id. Multiple crm activty ids can be applied
          explode: false
          in: query
          name: crm_activity_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by action_id. Multiple action ids can be applied
          explode: false
          in: query
          name: action_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by user_id. Multiple User ids can be applied
          explode: false
          in: query
          name: user_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by status. Multiple status can be applied, possible values are sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters emails by cadence. Multiple cadence ids can be applied
          explode: false
          in: query
          name: cadence_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by step. Multiple step ids can be applied
          explode: false
          in: query
          name: step_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by one-off only
          in: query
          name: one_off
          required: false
          schema:
            type: boolean
        - description: Specify explicit scoped fields desired on the Email Resource.
          explode: false
          in: query
          name: scoped_fields
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters emails by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters emails by recipient email address. Multiple emails can be applied.
          explode: false
          in: query
          name: email_addresses
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters emails by personalization score
          explode: false
          in: query
          name: personalization
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the sent_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: sent_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: updated_at, send_time. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Email"
                type: array
          description: Success
      summary: List emails
      tags:
        - Emails
  "/v2/activities/emails/{id}.json":
    get:
      description: |
        Fetches an email, by ID only.
      parameters:
        - description: Email ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Email"
          description: Success
      summary: Fetch an email
      tags:
        - Emails
  /v2/activity_histories:
    get:
      description: Fetches all of the customer's past activities for your application. Returns all the Activities that are found on the Salesloft Activity Feed. <a href="/activity-history.html" target="_blank" rel="noopener noreferrer">Visit here for more details</a>.
      parameters:
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: occurred_at, updated_at. Defaults to occurred_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: "Filter by the type of activity. Must be one of: added_to_cadence, completed_action, call, requested_email, sent_email, received_email, email_reply, note, success, dnc_event, residency_change, meeting, meeting_held, message_conversation, task, voicemail, opportunity_stage_change, opportunity_amount_change, opportunity_close_date_change. Can be provided as an array, or as an object of type[resource_type][]=type"
          in: query
          name: type
          required: false
          schema:
            type: string
        - description: For internal use only. This field does not comply with our backwards compatibility policies. This filter is for authenticated users of Salesloft only and will not work for OAuth Applications. Filter by the {resource_type, resource_id} of activity. Provide this in the format resource[]=person,1234
          in: query
          name: _resource
          required: false
          schema:
            type: string
        - description: |
            Equality filters that are applied to the occurred_at field. A single filter can be used by itself or combined with other filters to create a range.
            ---CUSTOM---
            {"keys":[{"description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gt","type":"iso8601 string"},{"description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gte","type":"iso8601 string"},{"description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lt","type":"iso8601 string"},{"description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lte","type":"iso8601 string"}],"type":"object"}
          in: query
          name: occurred_at
          required: false
          schema:
            type: object
        - description: Filter by the pinned status of activity. Must be 'true' or 'false'
          in: query
          name: pinned
          required: false
          schema:
            type: boolean
        - description: Filter by the resource type. A resource is a Salesloft object that the activity is attributed to. A valid resource types must be one of person, account, crm_opportunity. Can be provided as an array
          in: query
          name: resource_type
          required: false
          schema:
            type: string
        - description: Filter by the resource id. "resource_type" filter is required to use this filter.
          explode: false
          in: query
          name: resource_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.
            ---CUSTOM---
            {"keys":[{"description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gt","type":"iso8601 string"},{"description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gte","type":"iso8601 string"},{"description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lt","type":"iso8601 string"},{"description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lte","type":"iso8601 string"}],"type":"object"}
          in: query
          name: updated_at
          required: false
          schema:
            type: object
        - description: Filter activities by a user's guid.
          in: query
          name: user_guid
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/ActivityHistory"
          description: Success
      summary: List Past Activities
      tags:
        - Activity Histories
  /v2/bulk_jobs:
    get:
      description: Fetches multiple bulk job records. The records can be filtered, paged, and sorted according to the respective parameters.
      parameters:
        - description: "The state of the bulk job. Accepts multiple states. Each state must be one of: open, executing, done"
          explode: false
          in: query
          name: state
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filter by id using comparison operators. Only supports greater than (gt) comparison (i.e. id[gt]=123)
          in: query
          name: id
          required: false
          schema:
            type: object
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/BulkJob"
                type: array
          description: Success
      summary: List bulk jobs
      tags:
        - Bulk Jobs
    post:
      description: |
        Creates a bulk job. The type of the bulk job must be included when created.

        For additional information on creating bulk jobs, the types of supported bulk jobs, and examples of the bulk job flow, visit the <a href="/bulk.html" target="_blank" rel="noopener noreferrer">bulk job details page</a>.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                name:
                  description: Name for your bulk job
                  type: string
                type:
                  description: Type of bulk job. Must be a valid type. Follow link to the bulk job details page above to view supported types.
                  type: string
              required:
                - type
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/BulkJob"
          description: Success
      summary: Create a bulk job
      tags:
        - Bulk Jobs
  "/v2/bulk_jobs/{bulk_jobs_id}/job_data":
    get:
      description: Fetches multiple job data records for a given bulk job. Pagination is not supported, but cursor based polling is via use of the `id[gt]` filter. Pass the last id seen (i.e. `id[gt]=1234`) in order to get the next batch of records.
      parameters:
        - description: The id for the bulk job to which the job data relates
          in: path
          name: bulk_jobs_id
          required: true
          schema:
            type: integer
        - description: Filter by result status. Accepts multiple statuses. Each status must be one of pending, success, error, retrying
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filter by id using comparison operators. Only supports greater than (gt) comparison (i.e. id[gt]=123)
          in: query
          name: id
          required: false
          schema:
            type: object
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/BulkJobResult"
                type: array
          description: Success
      summary: List job data for a bulk job
      tags:
        - Bulk Jobs - Job Data
    post:
      description: |
        Upload job data for the specified bulk job. Upload an array of objects, where element contains the parameters necessary to execute the individual calls. Each call to this endpoint can handle up to 5,000 records at a time. There is no limit to how many times you can create job data for a given bulk job.

        For additional information on creating bulk jobs, the types of supported bulk jobs, and examples of the bulk job flow, visit the <a href="/bulk.html" target="_blank" rel="noopener noreferrer">bulk job details page</a>.
      parameters:
        - description: The id for the bulk job to which the job data relates
          in: path
          name: bulk_jobs_id
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                data:
                  description: Array of objects containing parameters to be used to execute an instance of each. Array must be 5,000 records or less.
                  items:
                    type: string
                  type: array
              required:
                - data
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/JobDataCreationResult"
          description: Success
      summary: Create job data for a bulk job
      tags:
        - Bulk Jobs - Job Data
  "/v2/bulk_jobs/{bulk_jobs_id}/results":
    get:
      description: Fetches multiple job data records for a completed bulk job. Note that until a bulk job's state is set to `done` the returned `data` will be an empty array. Pagination is not supported, but cursor based polling is via use of the `id[gt]` filter. Pass the last id seen (i.e. `id[gt]=1234`) in order to get the next batch of records.
      parameters:
        - description: The id for the Bulk Job
          in: path
          name: bulk_jobs_id
          required: true
          schema:
            type: integer
        - description: Filter by result status. Accepts multiple statuses. Each status must be one of pending, success, error, retrying
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filter by id using comparison operators. Only supports greater than (gt) comparison (i.e. id[gt]=123)
          in: query
          name: id
          required: false
          schema:
            type: object
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/BulkJobResult"
                type: array
          description: Success
      summary: List job data for a completed bulk job.
      tags:
        - Bulk Jobs - Results
  "/v2/bulk_jobs/{id}":
    get:
      description: Fetches a bulk job, by ID only.
      parameters:
        - description: The id for the Bulk Job
          in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/BulkJob"
          description: Success
      summary: Fetch a bulk job
      tags:
        - Bulk Jobs
    put:
      description: |
        Updates a bulk job's name and / or marks a bulk job as 'ready_to_execute'.  May only be updated if the bulk job is still in an "open" state.

        For additional information on creating bulk jobs, the types of supported bulk jobs, and examples of the bulk job flow, visit the <a href="/bulk.html" target="_blank" rel="noopener noreferrer">bulk job details page</a>.
      parameters:
        - description: The id for the bulk job to which the job data relates
          in: path
          name: id
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                name:
                  description: Name for your bulk job
                  type: string
                ready_to_execute:
                  description: Whether the job is ready to be executed. Must be true or false.
                  type: boolean
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/BulkJob"
          description: Success
      summary: Update a bulk job
      tags:
        - Bulk Jobs
  "/v2/cadence_exports/{id}.json":
    get:
      description: |
        Exports a cadence as JSON.
      parameters:
        - description: Cadence ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CadenceExport"
          description: Success
      summary: Export a cadence
      tags:
        - Cadence Exports
  /v2/cadence_imports.json:
    post:
      description: |
        New cadences can be created or steps can be imported onto existing cadences which do not have steps.
        <a href="/cadence-imports.html" target="_blank" rel="noopener noreferrer">Visit here for more details</a>.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                cadence_content:
                  description: Import data for cadence
                  type: object
                settings:
                  description: Settings for a cadence
                  type: object
                sharing_settings:
                  description: The shared settings for a cadence
                  type: object
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CadenceImport"
          description: Success
      summary: Import cadences from JSON
      tags:
        - Cadence Imports
  /v2/cadence_memberships.json:
    get:
      description: |
        Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to
        the respective parameters. A cadence membership is the association between a person and their current and
        historical time on a cadence. Cadence membership records are mutable and change over time. If a person is
        added to a cadence and re-added to the same cadence in the future, there is a single membership record.
      parameters:
        - description: IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: ID of the person to find cadence memberships for
          in: query
          name: person_id
          required: false
          schema:
            type: integer
        - description: ID of the cadence to find cadence memberships for
          in: query
          name: cadence_id
          required: false
          schema:
            type: integer
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: If true, return only cadence memberships for people currently on cadences.  If false, return cadence memberships for people who have been removed from or have completed a cadence.
          in: query
          name: currently_on_cadence
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: added_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CadenceMembership"
                type: array
          description: Success
      summary: List cadence memberships
      tags:
        - Cadence Memberships
    post:
      description: |
        Adds a person to a cadence. person_id and cadence_id are required, and must be visible to the authenticated user. user_id will
        default to the authenticated user, but can be set to any visible user on the authenticated team.

        A person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, the cadence is owned by
        the teammate, or the teammate has the Personal Cadence Admin permission.
      parameters:
        - description: ID of the person to create a cadence membership for
          in: query
          name: person_id
          required: true
          schema:
            type: integer
        - description: ID of the cadence to create a cadence membership for
          in: query
          name: cadence_id
          required: true
          schema:
            type: integer
        - description: ID of the user to create a cadence membership for. The associated cadence must be owned by the user, or it must be a team cadence
          in: query
          name: user_id
          required: false
          schema:
            type: integer
        - description: ID of the step on which the person should start the cadence. Start on first step is the default behavior without this parameter.
          in: query
          name: step_id
          required: false
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CadenceMembership"
          description: Success
      summary: Create a cadence membership
      tags:
        - Cadence Memberships
  "/v2/cadence_memberships/{id}.json":
    delete:
      description: |
        Cadence Membership
      parameters:
        - description: CadenceMembership ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The person has been removed from the cadence successfully
      summary: Delete a cadence membership
      tags:
        - Cadence Memberships
    get:
      description: |
        Fetches a cadence membership, by ID only.
      parameters:
        - description: CadenceMembership ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CadenceMembership"
          description: Success
      summary: Fetch a cadence membership
      tags:
        - Cadence Memberships
  /v2/cadences.json:
    get:
      description: |
        Fetches multiple cadence records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of cadences to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters cadences by whether they are a team cadence or not
          in: query
          name: team_cadence
          required: false
          schema:
            type: boolean
        - description: Filters cadences by whether they are shared
          in: query
          name: shared
          required: false
          schema:
            type: boolean
        - description: Filters cadences by the owner's guid. Multiple owner guids can be applied
          explode: false
          in: query
          name: owned_by_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters cadences by whether they are able to have people added to them
          in: query
          name: people_addable
          required: false
          schema:
            type: boolean
        - description: Filters cadences by name
          explode: false
          in: query
          name: name
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters by group ids. Also supports group ids passed in as a JSON array string
          in: query
          name: group_ids
          required: false
          schema:
            type: string
        - description: Filters by whether the Cadences have been archived. Excluding this field will result in both archived and unarchived Cadences to return.
          in: query
          name: archived
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Cadence"
                type: array
          description: Success
      summary: List cadences
      tags:
        - Cadences
  "/v2/cadences/{id}.json":
    get:
      description: |
        Fetches a cadence, by ID only.
      parameters:
        - description: Cadence ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Cadence"
          description: Success
      summary: Fetch a cadence
      tags:
        - Cadences
  /v2/calendar/events:
    get:
      description: Returns all calendar events, paginated and filtered by the date.
      parameters:
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: start_time. Defaults to start_time"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: |
            Lower bound (inclusive) for a calendar event's end time to filter by.
            Must be in ISO 8601 format.

            Example: `2022-02-14T10:12:59+00:00`.
          in: query
          name: start_time
          required: false
          schema:
            type: string
        - description: |
            Upper bound (exclusive) for a calendar event's start time to filter by.
            Must be in ISO 8601 format.

            Example: `2022-02-14T10:12:59+00:00`.
          in: query
          name: end_time
          required: false
          schema:
            type: string
        - description: |
            user_guid of the user who created or included as a guest to the event.
          in: query
          name: user_guid
          required: false
          schema:
            type: string
        - description: |
            calendar_id of the user who created or included as a guest to the event.
          in: query
          name: calendar_id
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CalendarEvent"
                type: array
          description: Success
      summary: List calendar events
      tags:
        - Calendar Events
  /v2/calendar/events/upsert:
    post:
      description: |2
          Upserts a calendar event object.
          Upsert key is a combination of `id` and `i_cal_uid` scoped to the given `calendar_id`.
          Bulk operations:
          This endpoint is used for bulk operations, see https://developers.salesloft.com/bulk.html for integration instructions.
          Use `calendar/events/upsert` as an event type, and this spec as a data spec.
          This endpoint should be used directly for the time sensitive calendar event updates.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                all_day:
                  description: Should be set to `true` for all day calendar events.
                  type: boolean
                attendees:
                  description: |2
                      List of attendees of the calendar event.
                      Example:
                      ```
                        {
                          ...
                          "attendees": [
                            {
                              "name": "Alice",
                              "email": "alice@example.com",
                              "status": "accepted",
                              "organizer": true
                            },
                            {
                              "name": "Bob",
                              "email": "bob@example.com",
                              "status": "needsAction",
                              "organizer": false
                            }
                          ]
                        }
                      ```
                      `name`: full name of the attendee

                      `email`: email address of the attendee

                      `status`: one of the following - needsAction, accepted, tentative, declined

                      `organizer`: whether the attendee is the organizer of the calendar event
                  type: object
                calendar_id:
                  description: |2
                      Calendar ID of the calendar event owner.
                      For the External Calendar connection use `external_{salesloft_user_guid}` format.
                      Example: `external_00210d1a-df8a-459f-af75-89b953b618b0`.
                  type: string
                canceled_at:
                  description: |2
                      Cancellation time of the calendar event, as a combined date-time value in the ISO 8601 format with a time zone offset.
                      Example: `2022-02-14T10:12:59+00:00`.
                  type: string
                description:
                  description: Description of the calendar event
                  type: string
                end_time:
                  description: |2
                      End time of the calendar event, as a combined date-time value in the ISO 8601 format with a time zone offset.
                      Example: `2022-02-14T10:12:59+00:00`.
                  format: date
                  type: string
                i_cal_uid:
                  description: |2
                      icalUID of the calendar event. Unique identifier for a calendar event across calendars.

                      Used as an upsert key.
                  type: string
                id:
                  description: |2
                      Id of the calendar event, different for each occurrence in a recurring series.

                      Used as an upsert key.
                  type: string
                location:
                  description: Location of the calendar event as free-form text.
                  type: string
                organizer:
                  description: |2
                      Email address of the organizer
                  type: string
                recurring:
                  description: Should be set to `true` if this is one of recurring series calendar event.
                  type: boolean
                start_time:
                  description: |2
                      Start time of the calendar event, as a combined date-time value in the ISO 8601 format with a time zone offset.
                      Example: `2022-02-14T10:12:59+00:00`.
                  format: date
                  type: string
                status:
                  description: |2
                      Status of the calendar event. Depending on the status, the calendar event will or will not impact user's availability.
                      Possible values: `confirmed`, `tentative`, `cancelled`.
                      Example: `confirmed`.
                  type: string
                title:
                  description: Title of the calendar event
                  type: string
                updated_at:
                  description: |2
                      Last modification time of the event in the ISO 8601 format with a time zone offset. The event will not be updated if the 'updated_at' timestamp from the payload is earlier than the one in the database.
                      Example: `2022-02-14T10:12:59+00:00`.
                  type: string
              required:
                - id
                - i_cal_uid
                - start_time
                - end_time
                - calendar_id
              type: object
        required: true
      responses:
        "201":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CalendarEvent"
          description: Success
      summary: Upsert a calendar event
      tags:
        - Calendar Events
  /v2/call_data_records.json:
    get:
      description: |
        Fetches multiple call data records. The records can be filtered, paged, and sorted according to
        the respective parameters.

        Call data records are records of all inbound and outbound calls through Salesloft. A call data record may
        be associated with a call, but does not have to be.
      parameters:
        - description: IDs of call data records to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Return only call data records which have or do not have a call logged for them
          in: query
          name: has_call
          required: false
          schema:
            type: boolean
        - description: |
            Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: created_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters list to only include guids
          explode: false
          in: query
          name: user_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters list by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CallDataRecord"
                type: array
          description: Success
      summary: List call data records
      tags:
        - Call Data Records
  "/v2/call_data_records/{id}.json":
    get:
      description: |
        Fetches a call data record, by ID only.
      parameters:
        - description: CallDataRecord ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CallDataRecord"
          description: Success
      summary: Fetch a call data record
      tags:
        - Call Data Records
  /v2/call_dispositions.json:
    get:
      description: |
        Fetches multiple call disposition records. The records can be sorted according to
        the respective parameters. Call dispositions must be configured in application. This will
        change in the future, but please contact us if you have a pressing use case.
      parameters:
        - description: "Key to sort on, must be one of: name, updated_at. Defaults to name"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to ASC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CallDisposition"
                type: array
          description: Success
      summary: List call dispositions
      tags:
        - Call Dispositions
  /v2/call_sentiments.json:
    get:
      description: |
        Fetches multiple call sentiment records. The records can be sorted according to
        the respective parameters. Call sentiments must be configured in application. This will
        change in the future, but please contact us if you have a pressing use case.
      parameters:
        - description: Filters call sentiments by name
          in: query
          name: name
          required: false
          schema:
            type: string
        - description: "Key to sort on, must be one of: name, updated_at. Defaults to name"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to ASC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CallSentiment"
                type: array
          description: Success
      summary: List call sentiments
      tags:
        - Call Sentiments
  /v2/conversations/calls:
    post:
      description: Enqueue a Conversations Call for processing
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                call_created_at:
                  description: Timestamp for when the call started. If not provided, will default to the time the request was received
                  type: string
                direction:
                  description: Call direction
                  type: string
                duration:
                  description: Duration of call in seconds
                  type: number
                from:
                  description: Phone number that call was made from
                  type: string
                recording:
                  description: Object containing recording info including the audio file (.mp3, .wav, .ogg, .m4a)
                  type: object
                to:
                  description: " Phone number that was called"
                  type: string
                user_guid:
                  description: Guid of the Salesloft User to assign the call to. If not provided, will default to the user within the authentication token
                  type: string
              required:
                - to
                - from
                - duration
                - recording
              type: object
        required: true
      responses:
        "201":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/ConversationsCall"
          description: Success
      summary: Create Conversations Call
      tags:
        - Conversations Calls
  /v2/crm_activities.json:
    get:
      description: |
        Fetches multiple crm activity records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of crm activities to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CrmActivity"
                type: array
          description: Success
      summary: List crm activities
      tags:
        - CRM Activities
  "/v2/crm_activities/{id}.json":
    get:
      description: |
        Fetches a crm activity, by ID only.
      parameters:
        - description: Crm activity ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CrmActivity"
          description: Success
      summary: Fetch a crm activity
      tags:
        - CRM Activities
  /v2/crm_activity_fields.json:
    get:
      description: |
        Fetches multiple crm activity field records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: Return only records with this source
          in: query
          name: source
          required: false
          schema:
            type: string
        - description: "Key to sort on, must be one of: title, updated_at. Defaults to title"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to ASC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CrmActivityField"
                type: array
          description: Success
      summary: List crm activity fields
      tags:
        - CRM Activity Fields
  /v2/crm_users.json:
    get:
      description: |
        Crm Users
      parameters:
        - description: IDs of crm users to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters crm users by crm_ids
          explode: false
          in: query
          name: crm_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters crm users by user_ids
          explode: false
          in: query
          name: user_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters crm users by user guids
          explode: false
          in: query
          name: user_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: id, updated_at. Defaults to id"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CrmUser"
                type: array
          description: Success
      summary: List crm users
      tags:
        - Crm Users
  /v2/custom_fields.json:
    get:
      description: |
        Fetches multiple custom field records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of custom fields to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Type of field to fetch. Value must be one of: person, company, opportunity"
          in: query
          name: field_type
          required: false
          schema:
            type: string
        - description: "Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CustomField"
                type: array
          description: Success
      summary: List custom fields
      tags:
        - Custom Fields
    post:
      description: |
        Creates a custom field.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                field_type:
                  description: "The field type of the custom field. Value must be one of: person, company, opportunity"
                  type: string
                name:
                  description: The name of the custom field
                  type: string
              required:
                - name
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CustomField"
          description: Success
      summary: Create a custom field
      tags:
        - Custom Fields
  "/v2/custom_fields/{id}.json":
    delete:
      description: |
        Deletes a custom field.
      parameters:
        - description: Custom Field ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The Custom Field has been deleted successfully
      summary: Delete a custom field
      tags:
        - Custom Fields
    get:
      description: |
        Fetches a custom field, by ID only.
      parameters:
        - description: Custom Field ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CustomField"
          description: Success
      summary: Fetch a custom field
      tags:
        - Custom Fields
    put:
      description: |
        Update a custom field.
      parameters:
        - description: Custom Field ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                field_type:
                  description: "The field type of the custom field. Value must be one of: person, company, opportunity"
                  type: string
                name:
                  description: The name of the custom field
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CustomField"
          description: Success
      summary: Update a custom field
      tags:
        - Custom Fields
  /v2/custom_roles.json:
    get:
      description: |
        Fetches multiple custom role records. The records can be filtered, and sorted according to
        the respective parameters. A custom role is any role that is not Admin or User.
      parameters:
        - description: IDs of roles to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: id, name. Defaults to id"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CustomRole"
                type: array
          description: Success
      summary: List custom roles
      tags:
        - Roles
  "/v2/custom_roles/{id}.json":
    get:
      description: |
        Fetches a custom role, by ID only.
      parameters:
        - description: Custom Role ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/CustomRole"
          description: Success
      summary: Fetch a custom role
      tags:
        - Roles
  /v2/email_template_attachments.json:
    get:
      description: |
        Fetches multiple email template attachment records. The records can be filtered and paged according to
        the respective parameters.
      parameters:
        - description: IDs of email template attachments to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters email template attachments by email template IDs
          explode: false
          in: query
          name: email_template_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/EmailTemplateAttachment"
                type: array
          description: Success
      summary: List email template attachments
      tags:
        - Email Template Attachments
  /v2/email_templates.json:
    get:
      description: |
        Fetches multiple email template records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of email templates to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters email templates by whether they are linked to a team template or not
          in: query
          name: linked_to_team_template
          required: false
          schema:
            type: boolean
        - description: Filters email templates by title or subject
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: Filters email templates by tags applied to the template by tag ID, not to exceed 100 IDs
          explode: false
          in: query
          name: tag_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters email templates by tags applied to the template, not to exceed 100 tags
          explode: false
          in: query
          name: tag
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters email templates by current authenticated user
          in: query
          name: filter_by_owner
          required: false
          schema:
            type: boolean
        - description: Filters email templates by groups applied to the template by group ID. Not to exceed 500 IDs. Returns templates that are assigned to any of the group ids.
          explode: false
          in: query
          name: group_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters email templates based on whether or not the template has been used on a cadence
          in: query
          name: include_cadence_templates
          required: false
          schema:
            type: boolean
        - description: Filters email templates to include archived templates or not
          in: query
          name: include_archived_templates
          required: false
          schema:
            type: boolean
        - description: Filters email templates to those belonging to the cadence. Not to exceed 100 IDs. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: cadence_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at, last_used_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/EmailTemplate"
                type: array
          description: Success
      summary: List email templates
      tags:
        - Email Templates
  "/v2/email_templates/{id}.json":
    get:
      description: |
        Fetches an email template, by ID only.
      parameters:
        - description: EmailTemplate ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Optionally will return the templates with the current user's email signature
          in: query
          name: include_signature
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/EmailTemplate"
          description: Success
      summary: Fetch an email template
      tags:
        - Email Templates
  /v2/external_emails.json:
    post:
      description: |
        Creates an external email object.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                mailbox:
                  description: Email address of mailbox email was sent to
                  type: string
                raw:
                  description: Base64 encoded MIME email content
                  type: string
              required:
                - mailbox
                - raw
              type: object
        required: true
      responses:
        "201":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/ExternalEmail"
          description: Success
      summary: Create an External Email
      tags:
        - External Emails
  /v2/groups.json:
    get:
      description: |
        Fetches multiple group records. The records can be filtered, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of groups to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Group"
                type: array
          description: Success
      summary: List groups
      tags:
        - Groups
  "/v2/groups/{id}.json":
    get:
      description: |
        Fetches a group, by ID only.
      parameters:
        - description: Group ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Group"
          description: Success
      summary: Fetch a group
      tags:
        - Groups
  /v2/imports.json:
    get:
      description: |
        Fetches multiple imports.
      parameters:
        - description: IDs of imports to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: ID of users to fetch imports for. Using this filter will return an empty array for non-admin users who request other user's imports
          explode: false
          in: query
          name: user_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to created_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Import"
                type: array
          description: Success
      summary: List imports
      tags:
        - Imports
    post:
      description: |
        Creates an import.
      requestBody:
        $ref: "#/components/requestBodies/postV2ImportsJson"
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Import"
          description: Success
      summary: Create an import
      tags:
        - Imports
  "/v2/imports/{id}.json":
    delete:
      description: |
        Deletes an import, by ID only. The associated people can be deleted as part of the deletion process.

        Admin users can access imports for the entire team, but non-admin users can only access their own imports.
      parameters:
        - description: Import ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: |
            Whether to delete people on this Import. Possible values are: [not present], all, single.

            'single' will delete people who are only present in this Import.
            'all' will delete people even if they are present in other Imports.
            Not specifying this parameter will not delete any people
          in: query
          name: undo
          required: false
          schema:
            type: string
      responses:
        "204":
          description: The import has been deleted successfully
      summary: Delete an import
      tags:
        - Imports
    get:
      description: |
        Fetches an import, by ID only.

        Admin users can access imports for the entire team, but non-admin users can only access their own imports.
      parameters:
        - description: Import ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Import"
          description: Success
      summary: Fetch an import
      tags:
        - Imports
    put:
      description: |
        Updates an import, by ID only.

        Admin users can access imports for the entire team, but non-admin users can only access their own imports.
      parameters:
        - description: Import ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        $ref: "#/components/requestBodies/postV2ImportsJson"
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Import"
          description: Success
      summary: Update an import
      tags:
        - Imports
  /v2/live_website_tracking_parameters.json:
    post:
      description: |
        Creates a Live Website Tracking parameter to identify a person
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                person_id:
                  description: The person to create the LiveWebsiteTrackingParameter for
                  type: integer
              required:
                - person_id
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/LiveWebsiteTrackingParameter"
          description: Success
      summary: Create an Live Website Tracking Parameter
      tags:
        - Live Website Tracking Parameters
  /v2/me.json:
    get:
      description: |
        Authenticated user information. This endpoint does not accept any parameters as it is
        represents your authenticated user. The "Users" resource provides user information
        for other users on the team.
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/User"
          description: Success
      summary: Fetch current user
      tags:
        - Me
  /v2/meetings.json:
    get:
      description: |
        Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters.
        Meetings resource is responsible for events created via the Salesloft platform using calendaring features.
        These events can relate to cadences, people, and accounts.
      parameters:
        - description: IDs of meetings to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Filters meetings by status. Possible values are: pending, booked, failed, retry"
          in: query
          name: status
          required: false
          schema:
            type: string
        - description: Filters meetings by person_id. Multiple person ids can be applied
          in: query
          name: person_id
          required: false
          schema:
            type: string
        - description: Filters meetings by account_id. Multiple account ids can be applied
          in: query
          name: account_id
          required: false
          schema:
            type: string
        - description: Filters meetings by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: List of event IDs. If both event_ids and i_cal_uids params are passed, this filters will be ORed. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: event_ids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: List of UIDs provided by calendar provider. If both event_ids and i_cal_uids params are passed, this filters will be ORed. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: i_cal_uids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters meetings by task_id. Multiple task ids can be applied
          explode: false
          in: query
          name: task_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Flag to indicate whether to include owned_by_meetings_settings and booked_by_meetings_settings objects
          in: query
          name: include_meetings_settings
          required: false
          schema:
            type: boolean
        - description: |
            Equality filters that are applied to the start_time field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: start_time
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: created_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters meetings by user_guid. Multiple user guids can be applied
          explode: false
          in: query
          name: user_guids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Whether to include deleted events in the result
          in: query
          name: show_deleted
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: start_time, created_at, updated_at. Defaults to start_time"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Meeting"
                type: array
          description: Success
      summary: List meetings
      tags:
        - Meetings
  /v2/meetings/settings/searches.json:
    post:
      description: |
        Fetches multiple meeting setting records. The records can be filtered, paged, and sorted according to the respective parameters.
      parameters:
        - description: Filters meeting settings by array of user_guids
          explode: false
          in: query
          name: user_guids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters meeting settings by calendar type
          in: query
          name: calendar_type
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/MeetingSetting"
                type: array
          description: Success
        "403":
          description: "This endpoint is not available without the following permissions: manage_team"
      summary: List meeting settings
      tags:
        - Meetings Settings - Searches
  "/v2/meetings/settings/{id}.json":
    put:
      description: |
        Updates a meeting setting, by ID only.
      parameters:
        - description: MeetingSetting ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                allow_booking_on_behalf:
                  description: Allow other team members to schedule on you behalf.
                  type: boolean
                allow_booking_overtime:
                  description: Allow team members to insert available time outside your working hours.
                  type: boolean
                allow_event_overlap:
                  description: Allow team members to double book events on your calendar.
                  type: boolean
                availability_limit:
                  description: The number of days out the user allows a prospect to schedule a meeting
                  type: integer
                availability_limit_enabled:
                  description: If Availability Limits have been turned on
                  type: boolean
                buffer_time_duration:
                  description: Default buffer duration in minutes set by a user
                  type: integer
                calendar_type:
                  description: Calendar type
                  type: string
                default_meeting_length:
                  description: Default meeting length in minutes set by the user
                  type: integer
                description:
                  description: Default description of the meeting
                  type: string
                enable_calendar_sync:
                  description: Determines if a user enabled Calendar Sync feature
                  type: boolean
                enable_dynamic_location:
                  description: Determines if location will be filled via third-party service (Zoom, GoToMeeting, etc.)
                  type: boolean
                location:
                  description: Default location of the meeting
                  type: string
                primary_calendar_connection_failed:
                  description: Determines if the user lost calendar connection
                  type: boolean
                primary_calendar_id:
                  description: ID of the primary calendar
                  type: string
                primary_calendar_name:
                  description: Display name of the primary calendar
                  type: string
                reschedule_meetings_enabled:
                  description: Determines if a user enabled reschedule meetings feature
                  type: boolean
                schedule_buffer_enabled:
                  description: Determines if meetings are scheduled with a 15 minute buffer between them
                  type: boolean
                schedule_delay:
                  description: The number of hours in advance a user requires someone to a book a meeting with them
                  type: integer
                share_event_detail:
                  description: Allow team members to see the details of events on your calendar.
                  type: boolean
                time_zone:
                  description: Time zone for current calendar
                  type: string
                times_available:
                  description: Times available set by a user that can be used to book meetings
                  type: object
                title:
                  description: Default title of the meeting
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/MeetingSetting"
          description: Success
      summary: Update a meeting setting
      tags:
        - Meeting Settings
  "/v2/meetings/{id}.json":
    put:
      description: |
        Updates a meeting, by ID only.
      parameters:
        - description: Meeting ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                event_id:
                  description: Meeting ID from the calendar provider
                  type: string
                i_cal_uid:
                  description: Meeting unique identifier (iCalUID)
                  type: string
                no_show:
                  description: Whether the meeting is a No Show meeting
                  type: boolean
                reschedule_status:
                  description: "Status of the meeting rescheduling progress. Possible values are: pending, booked, failed, retry"
                  type: string
                status:
                  description: "Status of the meeting creation progress. Possible values are: pending, booked, failed, retry"
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Meeting"
          description: Success
      summary: Update a meeting
      tags:
        - Meetings
  "/v2/mime_email_payloads/{id}.json":
    get:
      description: |
        Fetch the MIME content for email.
      parameters:
        - description: ID of Email
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/MimeEmailPayload"
          description: Success
      summary: Fetch the MIME content for email
      tags:
        - Mime Email Payloads
  /v2/notes.json:
    get:
      description: |
        Fetches multiple note records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: "Case insensitive type of item with which the note is associated.  Value must be one of: person, account"
          in: query
          name: associated_with_type
          required: false
          schema:
            type: string
        - description: ID of the item with which the note is associated.  The associated_with_type must also be present if this parameter is used
          in: query
          name: associated_with_id
          required: false
          schema:
            type: integer
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: IDs of notes to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Note"
                type: array
          description: Success
      summary: List notes
      tags:
        - Notes
    post:
      description: |
        Creates a note.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                associated_with_id:
                  description: ID of the item with which the note is associated
                  type: integer
                associated_with_type:
                  description: "Case insensitive type of item with which the note is associated.  Value must be one of: person, account"
                  type: string
                call_id:
                  description: ID of the call with which the note is associated. The call cannot already have a note
                  type: integer
                content:
                  description: The content of the note
                  type: string
                skip_crm_sync:
                  description: Boolean indicating if the CRM sync should be skipped.  No syncing will occur if true
                  type: boolean
                subject:
                  description: The subject of the note's crm activity, defaults to 'Note'
                  type: string
                user_guid:
                  description: The user to create the note for. Only team admins may create notes on behalf of other users. Defaults to the requesting user
                  type: string
              required:
                - content
                - associated_with_type
                - associated_with_id
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Note"
          description: Success
      summary: Create a note
      tags:
        - Notes
  "/v2/notes/{id}.json":
    delete:
      description: |
        Deletes a note owned by authorized account.
        This operation is not reversible without contacting support.
        This operation can be called multiple times successfully.
      parameters:
        - description: Note ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The Note has been deleted successfully
      summary: Delete a note
      tags:
        - Notes
    get:
      description: |
        Fetches a note, by ID only.
      parameters:
        - description: Note ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Note"
          description: Success
      summary: Fetch a note
      tags:
        - Notes
    put:
      description: |
        Updates a note. Any changes to the note or associated records will not reflect in your CRM.
      parameters:
        - description: Note ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                call_id:
                  description: ID of the call with which the note is associated. The call cannot already have a note. If the note is associated to a call already, it will become associated to the requested call
                  type: integer
                content:
                  description: The content of the note
                  type: string
              required:
                - content
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Person"
          description: Success
      summary: Update a note
      tags:
        - Notes
  /v2/ongoing_actions.json:
    post:
      description: |
        Creates an ongoing action. An ongoing action is an action that is not yet completed,
        but progress has been made towards the completion. The user should not need to do
        anything for an ongoing action to be completed. An ongoing action can be later completed
        by creating an activity.

        Ongoing actions are marked as status=pending_activity.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                action_id:
                  description: |
                    Action that is being marked ongoing. This will validate that the action is still
                    valid before modifying it. Ongoing actions can not be marked ongoing.
                  type: integer
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Action"
          description: Success
      summary: Create an ongoing action
      tags:
        - Ongoing Actions
  /v2/pending_emails.json:
    get:
      description: |
        Fetches a list of emails ready to be sent by an external email service.
      parameters:
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/PendingEmail"
                type: array
          description: Success
      summary: Fetches a list of emails ready to be sent by an external email service. Only emails sent with an External Email Client will appear here.
      tags:
        - Pending Emails
  "/v2/pending_emails/{id}.json":
    put:
      description: |
        Updates the status of an email sent by an External Email Client. Does not affect lofted emails.
      parameters:
        - description: Email ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                error_message:
                  description: The error message indicating why the email failed to send
                  type: string
                message_id:
                  description: The message id of the email that was sent
                  type: string
                sent_at:
                  description: The time that the email was actually sent in iso8601 format
                  type: string
                status:
                  description: Delivery status of the email.  Valid statuses are 'sent' and 'failed'
                  type: string
              required:
                - message_id
                - status
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PendingEmail"
          description: Success
      summary: Updates the status of an email sent by an External Email Client
      tags:
        - Pending Emails
  /v2/people.json:
    get:
      description: |
        Fetches multiple person records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of people to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by email address. Multiple emails can be applied. An additional value of "_is_null" can be passed to filter people that do not have an email address.
          explode: false
          in: query
          name: email_addresses
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by the owner's guid. Multiple owner guids can be applied
          explode: false
          in: query
          name: owned_by_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Includes people that have a given person_stage. Multiple person stage ids can be applied. An additional value of "_is_null" can be passed to filter people that do not have a stage set.
          explode: false
          in: query
          name: person_stage_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters people by crm_id. Multiple crm ids can be applied
          explode: false
          in: query
          name: crm_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: 'Filters people by owner_crm_id. Multiple owner_crm_ids can be applied. An additional value of "_is_null" can be passed to filter people that are unowned. A "_not_in" modifier can be used to exclude specific owner_crm_ids. Example: v2/people?owner_crm_id[_not_in]=id'
          explode: false
          in: query
          name: owner_crm_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Includes people that have a given do_not_contact property
          in: query
          name: do_not_contact
          required: false
          schema:
            type: boolean
        - description: Includes people that can be emailed given do_not_contact and contact_restrictions property
          in: query
          name: can_email
          required: false
          schema:
            type: boolean
        - description: Includes people that can be called given do_not_contact and contact_restrictions property
          in: query
          name: can_call
          required: false
          schema:
            type: boolean
        - description: Includes people that can be sent a text message given do_not_contact and contact_restrictions property
          in: query
          name: can_text
          required: false
          schema:
            type: boolean
        - description: Filters people by the account they are linked to. Multiple account ids can be applied
          explode: false
          in: query
          name: account_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Filters by people matching all given custom fields. The custom field names are case-sensitive, but the provided values are case-insensitive. Example: v2/people?custom_fields[custom_field_name]=custom_field_value"
          in: query
          name: custom_fields
          required: false
          schema:
            type: object
        - description: Filters people that were imported by the given import ids. Multiple import ids can be applied. An additional value of "_is_null" can be passed to filter people that were not imported.
          explode: false
          in: query
          name: import_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters people by job seniorty. Multiple job seniorities can be applied. An additional value of "_is_null" can be passed to filter people do not have a job_seniority.
          explode: false
          in: query
          name: job_seniority
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by the tag ids applied to the person. Multiple tag ids can be applied.
          explode: false
          in: query
          name: tag_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters people by whether the owner is active or not.
          in: query
          name: owner_is_active
          required: false
          schema:
            type: boolean
        - description: Filters people by the cadence that they are currently on. Multiple cadence_ids can be applied. An additional value of "_is_null" can be passed to filter people that are not on a cadence.
          explode: false
          in: query
          name: cadence_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters people who have been starred by the user guids given.
          explode: false
          in: query
          name: starred_by_guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by whether or not they have replied to an email or not.
          in: query
          name: replied
          required: false
          schema:
            type: boolean
        - description: Filters people by whether an email that was sent to them bounced or not.
          in: query
          name: bounced
          required: false
          schema:
            type: boolean
        - description: Filters people by whether or not they have been marked as a success or not.
          in: query
          name: success
          required: false
          schema:
            type: boolean
        - description: Filters people by whether or not they are marked as an European Union Resident or not.
          in: query
          name: eu_resident
          required: false
          schema:
            type: boolean
        - description: Filters people by their title by exact match. Supports partial matching
          explode: false
          in: query
          name: title
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by their country by exact match. Supports partial matching
          explode: false
          in: query
          name: country
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by their state by exact match. Supports partial matching
          explode: false
          in: query
          name: state
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by their city by exact match. Supports partial matching
          explode: false
          in: query
          name: city
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range.
            Additional values of "_is_null" or "_is_not_null" can be passed to filter records that either have no timestamp value or any timestamp value.
            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          in: query
          name: last_contacted
          required: false
          schema:
            type: object
        - description: |
            Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          in: query
          name: created_at
          required: false
          schema:
            type: object
        - description: Filters people by whether or not that person is on a cadence or if they have been contacted in any way.
          in: query
          name: new
          required: false
          schema:
            type: boolean
        - description: Filter people by whether or not they have a phone number or not
          in: query
          name: phone_number
          required: false
          schema:
            type: boolean
        - description: Filters people by locales. Multiple locales can be applied. An additional value of "Null" can be passed to filter people that do not have a locale.
          explode: false
          in: query
          name: locales
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters people by owner_id. Multiple owner_ids can be applied.
          explode: false
          in: query
          name: owner_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: For internal use only. This field does not comply with our backwards compatibility policies. This filter is for authenticated users of Salesloft only and will not work for OAuth Applications. Filters people by the string provided. Can search and filter by name, title, industry, email_address and linked account name.
          in: query
          name: _query
          required: false
          schema:
            type: string
        - description: "Key to sort on, must be one of: created_at, updated_at, last_contacted_at, name, title, job_seniority, call_count, sent_emails, clicked_emails, replied_emails, viewed_emails, account, cadence_stage_name. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Person"
                type: array
          description: Success
      summary: List people
      tags:
        - People
    post:
      description: |
        Creates a person. Either email_address or phone/last_name must be provided as a unique lookup
        on the team.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_id:
                  description: ID of the Account to link this person to
                  type: integer
                autotag_date:
                  description: Whether the date should be added to this person as a tag. Default is false. The tag will be Y-m-d format.
                  type: boolean
                city:
                  description: City
                  type: string
                contact_restrictions:
                  description: "Specific methods of communication to prevent for this person. This will prevent individual execution of these communication types as well as automatically skip cadence steps of this communication type for this person in SalesLoft. Values currently accepted: call, email, message"
                  items:
                    type: string
                  type: array
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either a Lead (00Q) or Contact (003) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "person:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  type: object
                do_not_contact:
                  description: Whether or not this person has opted out of all communication. Setting this value to true prevents this person from being called, emailed, or added to a cadence in SalesLoft. If this person is currently in a cadence, they will be removed.
                  type: boolean
                email_address:
                  description: Email address
                  type: string
                first_name:
                  description: First name
                  type: string
                home_phone:
                  description: Home phone without formatting
                  type: string
                import_id:
                  description: ID of the Import this person is a part of. A person can be part of multiple imports, but this ID will always be the most recent Import
                  type: integer
                job_seniority:
                  description: The Job Seniority of a Person, must be one of director, executive, individual_contributor, manager, vice_president, unknown
                  type: string
                last_name:
                  description: Last name
                  type: string
                linkedin_url:
                  description: Linkedin URL
                  type: string
                locale:
                  description: Time locale of the person
                  type: string
                mobile_phone:
                  description: Mobile phone without formatting
                  type: string
                owner_id:
                  description: ID of the User that owns this person
                  type: integer
                person_company_industry:
                  description: Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_name:
                  description: Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_website:
                  description: Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_stage_id:
                  description: ID of the PersonStage of this person
                  type: integer
                personal_email_address:
                  description: Personal email address
                  type: string
                personal_website:
                  description: The website of this person
                  type: string
                phone:
                  description: Phone without formatting
                  type: string
                phone_extension:
                  description: Phone extension without formatting
                  type: string
                secondary_email_address:
                  description: Alternate email address
                  type: string
                state:
                  description: State
                  type: string
                tags:
                  description: All tags applied to this person
                  items:
                    type: string
                  type: array
                title:
                  description: Job title
                  type: string
                twitter_handle:
                  description: The twitter handle of this person
                  type: string
                work_city:
                  description: Work location - city
                  type: string
                work_country:
                  description: Work location - country
                  type: string
                work_state:
                  description: Work location - state
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Person"
          description: Success
      summary: Create a person
      tags:
        - People
  "/v2/people/{id}.json":
    delete:
      description: |
        Deletes a person. This operation is not reversible without contacting support.
        This operation can be called multiple times successfully.
      parameters:
        - description: Person id
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The person has been deleted successfully
      summary: Delete a person
      tags:
        - People
    get:
      description: |
        Fetches a person, by ID only.
      parameters:
        - description: Person ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Person"
          description: Success
      summary: Fetch a person
      tags:
        - People
    put:
      description: |
        Updates a person.
      parameters:
        - description: Person id
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_id:
                  description: ID of the Account to link this person to
                  type: integer
                city:
                  description: City
                  type: string
                contact_restrictions:
                  description: "Specific methods of communication to prevent for this person. This will prevent individual execution of these communication types as well as automatically skip cadence steps of this communication type for this person in SalesLoft. Values currently accepted: call, email, message"
                  items:
                    type: string
                  type: array
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either a Lead (00Q) or Contact (003) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "person:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  type: object
                do_not_contact:
                  description: Whether or not this person has opted out of all communication. Setting this value to true prevents this person from being called, emailed, or added to a cadence in SalesLoft. If this person is currently in a cadence, they will be removed.
                  type: boolean
                email_address:
                  description: Email address
                  type: string
                first_name:
                  description: First name
                  type: string
                home_phone:
                  description: Home phone without formatting
                  type: string
                import_id:
                  description: ID of the Import this person is a part of. A person can be part of multiple imports, but this ID will always be the most recent Import
                  type: integer
                job_seniority:
                  description: The Job Seniority of a Person, must be one of director, executive, individual_contributor, manager, vice_president, unknown
                  type: string
                last_name:
                  description: Last name
                  type: string
                linkedin_url:
                  description: Linkedin URL
                  type: string
                locale:
                  description: Time locale of the person
                  type: string
                mobile_phone:
                  description: Mobile phone without formatting
                  type: string
                owner_id:
                  description: ID of the User that owns this person
                  type: integer
                person_company_industry:
                  description: Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_name:
                  description: Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_website:
                  description: Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_stage_id:
                  description: ID of the PersonStage of this person
                  type: integer
                personal_email_address:
                  description: Personal email address
                  type: string
                personal_website:
                  description: The website of this person
                  type: string
                phone:
                  description: Phone without formatting
                  type: string
                phone_extension:
                  description: Phone extension without formatting
                  type: string
                secondary_email_address:
                  description: Alternate email address
                  type: string
                state:
                  description: State
                  type: string
                tags:
                  description: All tags applied to this person
                  items:
                    type: string
                  type: array
                title:
                  description: Job title
                  type: string
                twitter_handle:
                  description: The twitter handle of this person
                  type: string
                work_city:
                  description: Work location - city
                  type: string
                work_country:
                  description: Work location - country
                  type: string
                work_state:
                  description: Work location - state
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Person"
          description: Success
      summary: Update a person
      tags:
        - People
  /v2/person_stages.json:
    get:
      description: |
        Fetches multiple person stage records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of person stages to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/PersonStage"
                type: array
          description: Success
      summary: List person stages
      tags:
        - Person Stages
    post:
      description: |
        Creates a person stage.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                name:
                  description: The name of the new stage
                  type: string
              required:
                - name
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PersonStage"
          description: Success
      summary: Create a person stage
      tags:
        - Person Stages
  "/v2/person_stages/{id}.json":
    delete:
      description: |
        Deletes a person stage. This operation is not reversible without contacting support.
        This operation can be called multiple times successfully.
      parameters:
        - description: Stage ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The Person Stage has been deleted successfully
      summary: Delete an person stage
      tags:
        - Person Stages
    get:
      description: |
        Fetches a person stage, by ID only.
      parameters:
        - description: Stage ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PersonStage"
          description: Success
      summary: Fetch a person stage
      tags:
        - Person Stages
    put:
      description: |
        Updates a person stage.
      parameters:
        - description: Stage ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                name:
                  description: The name of the stage.
                  type: string
              required:
                - name
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PersonStage"
          description: Success
      summary: Update a person stage
      tags:
        - Person Stages
  /v2/person_upserts.json:
    post:
      description: |
        Upserts a person record. The upsert_key dictates how the upsert will be performed. The create and update behavior
        is exactly the same as the individual create and update endpoints.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                account_id:
                  description: ID of the Account to link this person to
                  type: integer
                city:
                  description: City
                  type: string
                contact_restrictions:
                  description: "Specific methods of communication to prevent for this person. This will prevent individual execution of these communication types as well as automatically skip cadence steps of this communication type for this person in SalesLoft. Values currently accepted: call, email, message"
                  items:
                    type: string
                  type: array
                country:
                  description: Country
                  type: string
                crm_id:
                  description: |+
                    Requires Salesforce.

                    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

                    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either a Lead (00Q) or Contact (003) object. The type will be validated using the 18 character ID.

                    This field can only be used if your application or API key has the "person:set_crm_id" scope.

                  type: string
                crm_id_type:
                  description: "The CRM that the provided crm_id is for. Must be one of: salesforce"
                  type: string
                custom_fields:
                  description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
                  type: object
                do_not_contact:
                  description: Whether or not this person has opted out of all communication. Setting this value to true prevents this person from being called, emailed, or added to a cadence in SalesLoft. If this person is currently in a cadence, they will be removed.
                  type: boolean
                email_address:
                  description: Email address
                  type: string
                first_name:
                  description: First name
                  type: string
                home_phone:
                  description: Home phone without formatting
                  type: string
                id:
                  description: |
                    ID of the person to update. Used if the upsert_key=id. When id and another upsert_key are provided,
                    the request will fail if the upsert record id and id parameter don't match.
                  type: integer
                import_id:
                  description: ID of the Import this person is a part of. A person can be part of multiple imports, but this ID will always be the most recent Import
                  type: integer
                job_seniority:
                  description: The Job Seniority of a Person, must be one of director, executive, individual_contributor, manager, vice_president, unknown
                  type: string
                last_name:
                  description: Last name
                  type: string
                linkedin_url:
                  description: Linkedin URL
                  type: string
                locale:
                  description: Time locale of the person
                  type: string
                mobile_phone:
                  description: Mobile phone without formatting
                  type: string
                owner_id:
                  description: ID of the User that owns this person
                  type: integer
                person_company_industry:
                  description: Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_name:
                  description: Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_company_website:
                  description: Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
                  type: string
                person_stage_id:
                  description: ID of the PersonStage of this person
                  type: integer
                personal_email_address:
                  description: Personal email address
                  type: string
                personal_website:
                  description: The website of this person
                  type: string
                phone:
                  description: Phone without formatting
                  type: string
                phone_extension:
                  description: Phone extension without formatting
                  type: string
                secondary_email_address:
                  description: Alternate email address
                  type: string
                state:
                  description: State
                  type: string
                tags:
                  description: All tags applied to this person
                  items:
                    type: string
                  type: array
                title:
                  description: Job title
                  type: string
                twitter_handle:
                  description: The twitter handle of this person
                  type: string
                upsert_key:
                  description: |
                    Name of the parameter to upsert on. The field must be provided in the input parameters, or the request will fail.
                    The request will also fail if there are multiple records matched by the upsert field. This can occur if intentional duplicates
                    by email address is enabled.

                    If upsert_key is not provided, this endpoint will not update an existing record.

                    Valid options are: id, crm_id, email_address. If crm_id is provided, then a valid crm_id_type must be provided, as documented
                    for the person create and update endpoints.
                  type: string
                work_city:
                  description: Work location - city
                  type: string
                work_country:
                  description: Work location - country
                  type: string
                work_state:
                  description: Work location - state
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PersonUpsert"
          description: Success
      summary: Upsert a person
      tags:
        - Person Upsert
  /v2/phone_number_assignments.json:
    get:
      description: |
        Fetches multiple phone number assignment records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of phone number assignments to fetch
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/PhoneNumberAssignment"
                type: array
          description: Success
      summary: List phone number assignments
      tags:
        - Phone Number Assignments
  "/v2/phone_number_assignments/{id}.json":
    get:
      description: |
        Fetches a phone number assignment, by ID only.
      parameters:
        - description: PhoneNumberAssignment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/PhoneNumberAssignment"
          description: Success
      summary: Fetch a phone number assignment
      tags:
        - Phone Number Assignments
  /v2/phone_numbers/caller_ids.json:
    get:
      description: |
        Each entry is a possible caller ID match for the number. Multiple
        entries may be returned if the phone number is present on more than one
        person in the system.  Phone number should be in E.164 format.
      parameters:
        - description: E.164 Phone Number
          in: query
          name: phone_number
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/CallerId"
                type: array
          description: Success
      summary: List caller ids
      tags:
        - Caller IDs
  "/v2/phone_numbers/recording_settings/{id}.json":
    get:
      description: |
        Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team.
        Phone number should be in E.164 format.
      parameters:
        - description: E.164 Phone Number
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/RecordingSetting"
          description: Success
      summary: Fetch recording setting
      tags:
        - Recording Settings
  /v2/saved_list_views.json:
    get:
      description: |
        Fetches multiple saved list view records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of saved list views to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Type of saved list views to fetch.
          in: query
          name: view
          required: false
          schema:
            type: string
        - description: "Key to sort on, must be one of: name. Defaults to name"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/SavedListView"
                type: array
          description: Success
      summary: List saved list views
      tags:
        - Saved List Views
    post:
      description: |
        Creates a saved list view.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                is_default:
                  description: Whether the saved list view is the default
                  type: boolean
                name:
                  description: The name of the saved list view
                  type: string
                view:
                  description: "The type of objects in the saved list view.  Value must be one of: people, companies, or recordings"
                  type: string
                view_params:
                  description: JSON object of list view parameters
                  type: string
              required:
                - name
                - view
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/SavedListView"
          description: Success
      summary: Create a saved list view
      tags:
        - Saved List Views
  "/v2/saved_list_views/{id}.json":
    delete:
      description: |
        Deletes a saved list view. This operation is not reversible without contacting support.
        This operation can be called multiple times successfully.
      parameters:
        - description: Saved List View ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: The saved list view has been deleted successfully
      summary: Delete a saved list view
      tags:
        - Saved List Views
    get:
      description: |
        Fetches a saved list view, by ID only.
      parameters:
        - description: Saved List View ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/SavedListView"
          description: Success
      summary: Fetch a saved list view
      tags:
        - Saved List Views
    put:
      description: |
        Updates a saved list view.
      parameters:
        - description: Saved List View ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                is_default:
                  description: Whether the saved list view is the default
                  type: boolean
                name:
                  description: The name of the saved list view
                  type: string
                view_params:
                  description: JSON object of list view parameters
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/SavedListView"
          description: Success
      summary: Update a saved list view
      tags:
        - Saved List Views
  /v2/steps.json:
    get:
      description: |
        Fetches multiple step records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of steps to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filter by cadence ID
          in: query
          name: cadence_id
          required: false
          schema:
            type: integer
        - description: Filter by step type
          in: query
          name: type
          required: false
          schema:
            type: string
        - description: Filter by whether a step has due actions
          in: query
          name: has_due_actions
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Step"
                type: array
          description: Success
      summary: List steps
      tags:
        - Steps
  "/v2/steps/{id}.json":
    get:
      description: |
        Fetches a step, by ID only.
      parameters:
        - description: Step ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Step"
          description: Success
      summary: Fetch a step
      tags:
        - Steps
  /v2/successes.json:
    get:
      description: |
        Fetches multiple success records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of successes to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters successes by person_id. Multiple person ids can be applied
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: created_at, updated_at, succeeded_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Success"
                type: array
          description: Success
      summary: List successes
      tags:
        - Successes
  /v2/tags.json:
    get:
      description: |
        Fetches a list of the tags used for a team. The records can be filtered, paged, and sorted according to
        the respective parameters.

        Tags can be applied to mulitple resource types.
      parameters:
        - description: Filters tags by name
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: Filters tags by their IDs
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Key to sort on, must be one of: name. Defaults to name"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Tag"
                type: array
          description: Success
      summary: List team tags
      tags:
        - Tags
  /v2/tasks.json:
    get:
      description: |
        Fetches multiple task records. The records can be filtered, paged, and sorted according to
        the respective parameters.
      parameters:
        - description: IDs of tasks to fetch.
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters tasks by the user to which they are assigned.
          explode: false
          in: query
          name: user_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters tasks by the person to which they are associated.
          explode: false
          in: query
          name: person_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters tasks by the account to which they are associated.
          explode: false
          in: query
          name: account_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: "Filters tasks by their current state. Valid current_states include: ['scheduled', 'completed']."
          explode: false
          in: query
          name: current_state
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Filters tasks by their task type. Valid task_types include: ['call', 'email', 'general']."
          explode: false
          in: query
          name: task_type
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Filters tasks by time interval. Valid time_intervals include: ['overdue', 'today', 'tomorrow', 'this_week', 'next_week']."
          in: query
          name: time_interval_filter
          required: false
          schema:
            type: string
        - description: Filters tasks by idempotency key.
          in: query
          name: idempotency_key
          required: false
          schema:
            type: string
        - description: Filters tasks by locale of the person to which they are associated.
          explode: false
          in: query
          name: locale
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: due_date, due_at. Defaults to due_date"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to ASC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Task"
                type: array
          description: Success
      summary: List tasks
      tags:
        - Tasks
    post:
      description: |
        Creates a task.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                current_state:
                  description: "Current state of the task, valid options are: scheduled"
                  type: string
                description:
                  description: A description of the task recorded for person at completion time
                  type: string
                due_date:
                  description: Date of when the Task is due, ISO-8601 date format required
                  type: string
                idempotency_key:
                  description: Establishes a unique identifier to prevent duplicates from being created
                  type: string
                person_id:
                  description: ID of the person to be contacted
                  type: string
                remind_at:
                  description: Datetime of when the user will be reminded of the task, ISO-8601 datetime format required
                  type: string
                subject:
                  description: Subject line of the task.
                  type: string
                task_type:
                  description: "Task type, valid options are: call, email, general"
                  type: string
                user_id:
                  description: ID of the user linked to the task
                  type: integer
              required:
                - subject
                - person_id
                - user_id
                - task_type
                - due_date
                - current_state
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Task"
          description: Success
      summary: Create a Task
      tags:
        - Tasks
  "/v2/tasks/{id}.json":
    get:
      description: |
        Fetches a task, by ID only.
      parameters:
        - description: Task ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Step"
          description: Success
      summary: Fetch a task
      tags:
        - Tasks
    put:
      description: |
        Updates a task.
      parameters:
        - description: Task ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                current_state:
                  description: "Current state of the task, valid options are: completed"
                  type: string
                description:
                  description: A description of the task recorded for person at completion time
                  type: string
                due_date:
                  description: Date of when the Task is due, ISO-8601 date format required
                  type: string
                is_logged:
                  description: A flag to indicate that the task should only be logged
                  type: boolean
                remind_at:
                  description: Datetime of when the user will be reminded of the task, ISO-8601 datetime format required
                  type: string
                subject:
                  description: Subject line of the task
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Task"
          description: Success
      summary: Update a Task
      tags:
        - Tasks
  /v2/team.json:
    get:
      description: |
        Fetches the team of the authenticated user.
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Team"
          description: Success
      summary: Fetch current team
      tags:
        - Team
  /v2/team_template_attachments.json:
    get:
      description: |
        Fetches multiple team template attachment records. The records can be filtered and paged according to
        the respective parameters.
      parameters:
        - description: IDs of team template attachments to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters template attachments by team template IDs
          explode: false
          in: query
          name: team_template_id
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/TeamTemplateAttachment"
                type: array
          description: Success
      summary: List team template attachments
      tags:
        - Team Template Attachments
  /v2/team_templates.json:
    get:
      description: |
        Fetches multiple team template records. The records can be filtered, paged, and sorted according to
        the respective parameters.

        Team templates are templates that are available team-wide. Admins may use
        team templates to create original content for the entire team, monitor version control to ensure templates are always up to date,
        and track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.
      parameters:
        - description: IDs of team templates to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: |
            Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.

            ---CUSTOM---
            {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}
          explode: false
          in: query
          name: updated_at
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters email templates by title or subject
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: Filters email templates by tags applied to the template by tag ID, not to exceed 100 IDs
          explode: false
          in: query
          name: tag_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters team templates by tags applied to the template, not to exceed 100 tags
          explode: false
          in: query
          name: tag
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters email templates to include archived templates or not
          in: query
          name: include_archived_templates
          required: false
          schema:
            type: boolean
        - description: "Key to sort on, must be one of: created_at, updated_at, last_used_at. Defaults to updated_at"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
        - description: How many records to show per page in the range [1, 100]. Defaults to 25
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch results from. Defaults to 1
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
          in: query
          name: limit_paging_counts
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/TeamTemplate"
                type: array
          description: Success
      summary: List team templates
      tags:
        - Team Templates
  "/v2/team_templates/{id}.json":
    get:
      description: |
        Fetches a team template, by ID only.
      parameters:
        - description: Team Template ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Optionally will return the templates with the current user's email signature
          in: query
          name: include_signature
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/TeamTemplate"
          description: Success
      summary: Fetch a team template
      tags:
        - Team Templates
  /v2/third_party_live_feed_items:
    post:
      description: Creates a live feed item that can be sent to users. May only be used by whitelisted Frontend Integrations. Reference the Salesloft App Directory and Frontend Integrations sections for additional details.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                event_occurred_at:
                  description: |
                    Equality filters that are applied to the event_occurred_at field. A single filter can be used by itself or combined with other filters to create a range.
                    ---CUSTOM---
                    {"keys":[{"description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gt","type":"iso8601 string"},{"description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"gte","type":"iso8601 string"},{"description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lt","type":"iso8601 string"},{"description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.","name":"lte","type":"iso8601 string"}],"type":"object"}
                  type: string
                idempotency_key:
                  description: Uniquely provided string specific to this event. This should be a value which can't be duplicated between external systems, meaning that an id is not sufficient.
                  type: string
                message:
                  description: The message that relates to the subject. This message should start with a lower-case past-tense verb and end with a period (e.g. "received a package."). When live feed items are displayed to users, the subject's name is concatenated with the message and a joining space. Only <a> HTML tags with an "href" attribute are allowed. Other attributes and tags will be stripped.
                  type: string
                subject_id:
                  description: The ID of the subject of the live feed item (i.e. the "person" id).
                  type: integer
                subject_type:
                  description: The type of the subject of the live feed item. Currently only "person" is supported.
                  type: string
                user_guid:
                  description: The guid for the user that this live feed item should be shown to.
                  type: string
              required:
                - subject_type
                - subject_id
                - event_occurred_at
                - user_guid
                - message
                - idempotency_key
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/LiveFeedItem"
                type: array
          description: Success
      summary: Create a live feed item
      tags:
        - Live Feed Items
  /v2/users.json:
    get:
      description: |
        Non Admin: Lists only your user, or all on team depending on group visibility policy
        Team Admin: Lists users associated with your team
      parameters:
        - description: IDs of users to fetch. If a record can't be found, that record won't be returned and your request will be successful
          explode: false
          in: query
          name: ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Filters list to only include guids
          explode: false
          in: query
          name: guid
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters users by group_id.  An additional value of "_is_null" can be passed to filter users that are not in a group
          explode: false
          in: query
          name: group_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Filters users by role_id
          explode: false
          in: query
          name: role_id
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: Space-separated list of keywords used to find case-insensitive substring matches against First Name, Last Name, or Email
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: Filters users based on active attribute. Defaults to not applied
          in: query
          name: active
          required: false
          schema:
            type: boolean
        - description: |
            Defaults to true.

            When true, only shows users that are actionable based on the team's privacy settings.
            When false, shows all users on the team, even if you can't take action on that user. Deactivated users are also included when false.
          in: query
          name: visible_only
          required: false
          schema:
            type: boolean
        - description: How many users to show per page in the range [1, 100]. Defaults to 25.  Results are only paginated if the page parameter is defined
          in: query
          name: per_page
          required: false
          schema:
            type: integer
        - description: The current page to fetch users from. Defaults to returning all users
          in: query
          name: page
          required: false
          schema:
            type: integer
        - description: Whether to include total_pages and total_count in the metadata. Defaults to false
          in: query
          name: include_paging_counts
          required: false
          schema:
            type: boolean
        - description: Filters users based on if they have a crm user mapped or not.
          in: query
          name: has_crm_user
          required: false
          schema:
            type: boolean
        - description: Filters users based on assigned work_country.
          explode: false
          in: query
          name: work_country
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: "Key to sort on, must be one of: id, email, name, group, role. Defaults to id"
          in: query
          name: sort_by
          required: false
          schema:
            type: string
        - description: "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
          in: query
          name: sort_direction
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/User"
                type: array
          description: Success
      summary: List users
      tags:
        - Users
  "/v2/users/{id}.json":
    get:
      description: |
        Fetches a user, by ID only.
      parameters:
        - description: User ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/User"
          description: Success
      summary: Fetch a user
      tags:
        - Users
    put:
      description: |
        Updates a user.
      parameters:
        - description: User ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                active:
                  description: Active status of the user's account
                  type: boolean
                group_id:
                  description: Group assigned to the user
                  type: integer
                role_id:
                  description: "Role assigned to the user. Must be one of: Admin, User, or a custom role ID"
                  type: string
                work_country:
                  description: The user's work country (alpha-2 code)
                  type: string
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/User"
          description: Success
      summary: Update a user
      tags:
        - Users
  /v2/webhook_subscriptions:
    get:
      description: Fetches all of the customer's webhook subscriptions for your application.
      parameters:
        - description: Filters webhook subscriptions by whether is enabled or not.
          in: query
          name: enabled
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            "*/*":
              schema:
                items:
                  $ref: "#/components/schemas/Subscription"
                type: array
          description: Success
      summary: List webhook subscriptions
      tags:
        - Webhook Subscriptions
    post:
      description: |-
        Creates a webhook subscription. Visit the <a href="/webhooks.html" target="_blank" rel="noopener noreferrer">webhooks page</a> for additional details and a list of available webhooks.
        Request must be made with a valid Oauth token or API key.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                callback_token:
                  description: Any string to be used as a shared secret when subscription events are published. SalesLoft will send the value of this callback_token in the payload of each event so the receiver may verify it matches the original value. This ensures webhook events are being delivered by SalesLoft.
                  type: string
                callback_url:
                  description: URL for your callback handler
                  type: string
                event_type:
                  description: Type of event the subscription is for. Visit the "Event Types" section of the webhooks page to find a list of supported event types.
                  type: string
              required:
                - callback_url
                - callback_token
                - event_type
              type: object
        required: true
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Subscription"
          description: Success
      summary: Create a webhook subscription
      tags:
        - Webhook Subscriptions
  "/v2/webhook_subscriptions/{id}":
    delete:
      description: Deletes a webhook subscription. This operation is not reversible without contacting support. This operation can be called multiple times successfully.
      parameters:
        - description: The id of the Webhook Subscription to delete
          in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        "204":
          description: This webhook subscription has been deleted successfully
      summary: Delete a webhook subscription
      tags:
        - Webhook Subscriptions
    get:
      description: Fetches a webhook subscription, by ID only.
      parameters:
        - description: The id for the Webhook Subscription
          in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Subscription"
          description: Success
      summary: Fetch a webhook subscription
      tags:
        - Webhook Subscriptions
    put:
      description: |-
        Updates a webhook subscription.
        Request must be made with a valid Oauth token or API key.
      parameters:
        - description: The Webhook Suscription id to update
          in: path
          name: id
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                enabled:
                  description: Enable or disable the webhook subscription
                  type: boolean
              type: object
      responses:
        "200":
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Subscription"
          description: Success
      summary: Update a webhook subscription
      tags:
        - Webhook Subscriptions
components:
  requestBodies:
    postV2ImportsJson:
      content:
        application/x-www-form-urlencoded:
          schema:
            properties:
              name:
                description: Name, recommended to be easily identifiable to a user
                type: string
              user_id:
                description: ID of the User that owns this Import
                type: integer
            type: object
  schemas:
    Account:
      properties:
        account_tier:
          $ref: "#/components/schemas/EmbeddedResource"
        archived_at:
          description: Datetime of when the Account was archived, if archived
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        city:
          description: City
          example: Dufftown
          type: string
        company_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        company_type:
          description: Type of the Account's company
          example: Private
          type: string
        conversational_name:
          description: Conversational name of the Account
          example: Hogwarts
          type: string
        country:
          description: Country
          example: Scotland
          type: string
        counts:
          $ref: "#/components/schemas/EmbeddedAccountCounts"
        created_at:
          description: Datetime of when the Account was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        creator:
          $ref: "#/components/schemas/EmbeddedResource"
        crm_id:
          description: CRM ID
          example: 003i000001mnhpD
          type: string
        crm_object_type:
          description: CRM object type
          example: account
          type: string
        crm_url:
          description: CRM url
          example: https://na15.salesforce.com/003i000001mnhpD
          type: string
        custom_fields:
          description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
          example:
            MyField: A Value
            Other: Field
          type: object
        description:
          description: Description
          example: British school of magic for students
          type: string
        do_not_contact:
          description: Whether this company has opted out of communications. Do not contact someone at this company when this is set to true
          example: true
          type: boolean
        domain:
          description: Website domain, not a fully qualified URI
          example: salesloft.com
          type: string
        founded:
          description: Date or year of founding
          example: March 1st, 1820
          type: string
        id:
          description: ID of Account
          example: 1
          type: integer
        industry:
          description: Industry
          example: Education
          type: string
        last_contacted_at:
          description: Datetime this Account was last contacted
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        last_contacted_by:
          $ref: "#/components/schemas/EmbeddedResource"
        last_contacted_person:
          $ref: "#/components/schemas/EmbeddedResource"
        last_contacted_type:
          description: The type of the last touch to this Account. Can be call, email, other
          example: call
          type: string
        linkedin_url:
          description: Full LinkedIn url
          example: https://www.linkedin.com/company/2296178/
          type: string
        locale:
          description: Time locale
          example: Europe/London
          type: string
        name:
          description: Account Full Name
          example: Hogwarts School of Witchcraft and Wizardry
          type: string
        owner:
          $ref: "#/components/schemas/EmbeddedResource"
        owner_crm_id:
          description: Mapped owner field from the CRM
          example: 003i000001mnhpD
          type: string
        phone:
          description: Phone number without formatting
          example: +1 444 555 6666
          type: string
        postal_code:
          description: Postal code
          example: "55555"
          type: string
        revenue_range:
          description: Estimated revenue range
          example: 1,000,000-2,000,000
          type: string
        size:
          description: Estimated number of people in employment
          example: "1500"
          type: string
        state:
          description: State
          example: Mortlach
          type: string
        street:
          description: Street name and number
          example: 4 Picket Drive
          type: string
        tags:
          description: All tags applied to this Account
          example:
            - 7-23-2017
            - dreamforce
          items:
            type: string
          type: array
        twitter_handle:
          description: Twitter handle, with @
          example: "@kyleporter"
          type: string
        updated_at:
          description: Datetime of when the Account was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user_relationships:
          description: Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values
          example:
            Other: _is_null
            bff: 0037h00000d78aAAAQ
          type: object
        website:
          description: Website
          example: https://salesloft.com
          type: string
    AccountStage:
      properties:
        created_at:
          description: Datetime of when the Account Stage was created
          example: 2023-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of Account Stage
          example: 1
          type: integer
        name:
          description: Name of Account Stage
          example: In Progress
          type: string
        order:
          description: Order of Account Stage
          example: 3
          type: integer
        updated_at:
          description: Datetime of when the Account Stage was last updated
          example: 2023-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    AccountTier:
      properties:
        created_at:
          description: Datetime of when the Account Tier was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of Account Tier
          example: 1
          type: integer
        name:
          description: Name of the Account Tier
          example: High Priority
          type: string
        order:
          description: The order of the account tier
          example: 2
          type: integer
        updated_at:
          description: Datetime of when the Account Tier was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    AccountUpsert:
      properties:
        account:
          $ref: "#/components/schemas/Account"
        upsert_type:
          description: "The type of upsert. One of: create, update"
          type: string
    Action:
      properties:
        action_details:
          $ref: "#/components/schemas/EmbeddedResource"
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        created_at:
          description: Datetime of when the Action was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        due:
          description: Whether this step is due
          example: true
          type: boolean
        due_on:
          description: When action is due
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of Action
          example: 1
          type: integer
        multitouch_group_id:
          description: ID of the multitouch group
          example: 1
          type: integer
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        status:
          description: |
            The current state of the person on the cadence. Possible values are:

            in_progress: this action has not been completed

            pending_activity: this action has been acted upon, but the action has not been completed.
            (i.e. the email is scheduled to send, but has not been delivered yet)
          example: in_progress
          type: string
        step:
          $ref: "#/components/schemas/EmbeddedResource"
        type:
          description: |
            The type of this action. Valid types are: email, phone, other. New types may be added in the future.
          example: phone
          type: string
        updated_at:
          description: Datetime of when the Action was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    Activity:
      properties:
        updated_at:
          description: Datetime of when the Activity was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    ActivityHistory:
      properties:
        created_at:
          description: When this record was created
          example: 2019-01-01T00:00:00.000000Z
          format: date-time
          type: string
        dynamic_data:
          description: Attributes from associated records. This is specific to the type of activity and may change over time. Not returned for create requests
          example:
            counts:
              clicks: 2
              replies: 1
              views: 3
            status: sent
            subject: Welcome to SalesLoft
          type: object
        failed_dynamic_resources:
          description: A list of remote resource names that failed to load. This is specific to the type of activity and may change over time. Not returned for create requests
          example:
            - email
          type: object
        id:
          description: ID of this activity
          example: 1
          type: integer
        occurred_at:
          description: When this activity occurred
          example: 2019-01-01T00:00:00.000000Z
          format: date-time
          type: string
        pinned_at:
          description: When this record was pinned
          example: 2019-01-01T00:00:00.000000Z
          format: date-time
          type: string
        resource_id:
          description: "ID of the resource this activity is for. It will be a string for the following resource types: crm_opportunity"
          example: 1
          type: integer
        resource_type:
          description: "Type of the resource this activity is for. One of: account, person"
          example: person
          type: integer
        static_data:
          description: The static data for this activity
          example:
            email_id: 2
          type: object
        type:
          description: The type of activity
          example: email
          type: string
        updated_at:
          description: When this record was updated
          example: 2019-01-01T00:00:00.000000Z
          format: date-time
          type: string
        user_guid:
          description: UUID of the user this activity is for
          example: 51398ccd-309e-467f-aae2-4b0f66b5c11d
          type: string
    BulkJob:
      properties:
        created_at:
          description: When this bulk job was created
          example: 2019-01-01T00:00:00-05:00
          format: date-time
          type: string
        errors:
          description: Number of errored records at the time of request for this Bulk Job
          example: 23
          type: integer
        finished_at:
          description: When this bulk job finished processing
          example: 2019-01-02T00:00:00-05:00
          format: date-time
          type: string
        id:
          description: ID of this Bulk Job
          example: 1
          type: integer
        marked_ready_at:
          description: When this bulk job was marked as ready to execute
          example: 2019-01-02T00:00:00-05:00
          format: date-time
          type: string
        name:
          description: Name of this Bulk Job
          example: Job Name
          type: string
        processed:
          description: Number of processed records at the time of request for this Bulk Job
          example: 50
          type: integer
        ready_to_execute:
          description: Whether the Bulk Job is ready to be executed
          example: false
          type: boolean
        scopes:
          description: Scopes
          example:
            - person:set_crm_id
          items: {}
          type: array
        started_at:
          description: When this bulk job started processing. null until bulk job is done
          example: 2019-01-02T00:00:00-05:00
          format: date-time
          type: string
        state:
          description: "State of the Bulk Job.  Must be one of: open, executing, done."
          example: open
          type: string
        total:
          description: Number of total records for this Bulk Job
          example: 1234
          type: integer
        type:
          description: Type of the Bulk Job.
          example: person/upsert
          type: string
        updated_at:
          description: When this bulk job was updated
          example: 2019-01-02T00:00:00-05:00
          format: date-time
          type: string
    BulkJobResult:
      properties:
        error:
          description: Error message for the record that was processed. Will be null if there was no error.
          example: "Missing required field: email address"
          type: string
        id:
          description: ID of the record that was processed
          example: 1
          type: integer
        record:
          description: The data that was used to process the operation
          example: '{first_name: "John", last_name: "Smith"}'
          type: object
        resource:
          description: The object containing the resulting resource from performing the bulk action on this record
          example: '{person: {...}, upsert_type: "create"}'
          type: object
        status:
          description: "Status of the record that was processed. Will be one of: success, error"
          example: error
          type: string
    Cadence:
      properties:
        added_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        archived_at:
          description: Datetime of when the cadence was archived, if archived
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        bounced_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        cadence_framework_id:
          description: ID of the cadence framework used to create steps for the cadence
          example: 1
          type: integer
        cadence_function:
          description: |
            The use case of the cadence. Possible values are:

            outbound: Denotes an outbound cadence, typically for sales purposes

            inbound: Denotes an inbound sales cadence

            event: Denotes a cadence used for an upcoming event

            other: Denotes a cadence outside of the standard process
          example: outbound
          type: string
        cadence_priority:
          $ref: "#/components/schemas/EmbeddedResource"
        counts:
          $ref: "#/components/schemas/CadenceCounts"
        created_at:
          description: Datetime of when the cadence was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        creator:
          $ref: "#/components/schemas/EmbeddedResource"
        draft:
          description: Whether this cadence is in draft mode
          example: false
          type: boolean
        external_identifier:
          description: Cadence External ID
          example: This is my external id
          type: string
        finished_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        groups:
          description: Groups to which this cadence is assigned, if any
          example:
            - _href: https://api.salesloft.com/v2/groups/921
              id: 921
          items:
            $ref: "#/components/schemas/EmbeddedResource"
          type: array
        id:
          description: ID of cadence
          example: 1
          type: integer
        name:
          description: Cadence name
          example: Prospecting - VP of Sales
          type: string
        opt_out_link_included:
          description: Whether this cadence is configured to include an opt-out link by default
          example: true
          type: boolean
        owner:
          $ref: "#/components/schemas/EmbeddedResource"
        remove_bounces_enabled:
          description: Whether this cadence is configured to automatically remove people who have bounced
          example: true
          type: boolean
        remove_replies_enabled:
          description: Whether this cadence is configured to automatically remove people who have replied
          example: true
          type: boolean
        replied_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        shared:
          description: Whether this cadence is visible to team members (shared)
          example: false
          type: boolean
        tags:
          description: All tags applied to this cadence
          example:
            - 7-23-2017
            - dreamforce
          items:
            type: string
          type: array
        team_cadence:
          description: Whether this cadence is a team cadence.  A team cadence is created by an admin and can be run by all users
          example: false
          type: boolean
        updated_at:
          description: Datetime of when the cadence was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    CadenceCounts:
      properties:
        cadence_people:
          description: The number of people that have ever been added to the cadence
          example: 59
          type: integer
        meetings_booked:
          description: The number of meetings booked and attributed to the cadence
          example: 10
          type: integer
        opportunities_created:
          description: The number of opportunities created and attributed to the cadence
          example: 10
          type: integer
        people_acted_on_count:
          description: The number of people that have been skipped, scheduled, or advanced in a cadence
          example: 1
          type: integer
        target_daily_people:
          description: The user defined target for number of people to add to the cadence each day
          example: 10
          type: integer
    CadenceExport:
      properties:
        cadence_content:
          description: The content of the cadence
          example: {}
          type: object
    CadenceImport:
      properties:
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
    CadenceMembership:
      properties:
        added_at:
          description: Datetime of when the person was last added to this cadence
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        counts:
          $ref: "#/components/schemas/CadenceMembershipCounts"
        created_at:
          description: Datetime of when the person was first added to this cadence
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        current_state:
          description: |
            The current state of the person on the cadence. Possible values are:

            processing: The person is being processed on a cadence. Cadence-related changes cannot be made at this time

            staged: The person is waiting for the first step in the cadence to occur

            active: The cadence has begun processing this person and is still in the process, but idle

            scheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur

            completed: The cadence has been completed for this person

            removed: The person was manually or automatically removed from the cadence

            removed_no_action: The person was removed from the cadence before any action occurred

            reassigned: The person's cadence execution was transferred to a different user, ending this user's interaction
          example: staged
          type: string
        currently_on_cadence:
          description: Whether the person is currently on the cadence
          example: false
          type: boolean
        id:
          description: Cadence membership ID
          example: 1
          type: integer
        latest_action:
          $ref: "#/components/schemas/EmbeddedResource"
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        person_deleted:
          description: Whether the associated person has since been deleted
          example: false
          type: boolean
        updated_at:
          description: Datetime of when the record was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    CadenceMembershipCounts:
      properties:
        bounces:
          description: The number of times emails sent from the cadence to the person bounced
          example: 0
          type: integer
        calls:
          description: The number of times a call was logged from the cadence to the person
          example: 2
          type: integer
        clicks:
          description: The number of times emails sent from the cadence to the person were clicked
          example: 5
          type: integer
        replies:
          description: The number of times emails sent from the cadence to the person were replied to
          example: 2
          type: integer
        sent_emails:
          description: The number of times emails were sent from the cadence to the person
          example: 4
          type: integer
        views:
          description: The number of times emails sent from the cadence to the person were opened
          example: 10
          type: integer
    CalendarEvent:
      properties:
        all_day:
          description: Whether the calendar event is an all-day event.
          example: false
          type: boolean
        attendees:
          description: The attendees of the calendar event.
          example:
            - deleted_at: null
              email: alice@example.com
              name: Alice
              organizer: true
              status: accepted
              status_changed: false
            - deleted_at: null
              email: bob@example.com
              name: Bob
              organizer: false
              status: accepted
              status_changed: false
          items: {}
          type: array
        body_html:
          description: Raw body content from Microsoft calendar events
          example: some html text
          type: string
        busy:
          description: Busy/free status of the calendar event
          example: false
          type: boolean
        calendar_id:
          description: Calendar ID of the user calendar.
          example: test@example.com
          type: string
        canceled_at:
          description: The canceled date of the calendar event.
          example: 2023-04-13T15:34:06.989910Z
          format: date-time
          type: string
        conference_data:
          description: The conference-related information, such as details of a Google Meet conference.
          example: {}
          type: object
        created_at:
          description: Creation time of the calendar event.
          example: 2023-04-13T15:34:06.989803Z
          format: date-time
          type: string
        creator:
          description: The creator email of the calendar event.
          example: creator@example.com
          type: string
        description:
          description: Description of the calendar event
          example: Calendar event description
          type: string
        end_time:
          description: The (exclusive) end time of the calendar event.
          example: 2023-04-13T15:34:06.989568Z
          format: date-time
          type: string
        extended_properties:
          description: Extended properties of the calendar event.
          example: {}
          type: object
        html_link:
          description: An absolute link to this calendar event in the Google Calendar Web UI.
          example: https://www.google.com/calendar/event?eid=Y2N
          type: string
        i_cal_uid:
          description: Calendar event unique identifier (iCalUID)
          example: 1p1oilmc4mt3m6ah6rmf6ik8mm@google.com
          type: string
        id:
          description: The calendar event original ID from calendar provider
          example: AAMkADQ0NjE4YmY5LTc3ZDYtNDc5NC1-UlgAAAAAAENAAB3eGoN5TIDTp8dXXDpxUlgAACQlfLuAAA=
          type: string
        location:
          description: Location of the calendar event
          example: Event location
          type: string
        organizer:
          description: The organizer email of the calendar event.
          example: organizer@example.com
          type: string
        provider:
          description: The provider of the calendar event.
          example: google
          type: string
        recurring:
          description: Whether the calendar event is a recurring event.
          example: false
          type: boolean
        start_time:
          description: The (inclusive) start time of the calendar event.
          example: 2023-04-13T15:34:06.971963Z
          format: date-time
          type: string
        status:
          description: The status of the calendar event. It can be empty for non-google events.
          example: confirmed
          type: string
        tenant_id:
          description: Tenant ID of the user calendar
          example: 1
          type: integer
        title:
          description: Title of the calendar event
          example: Calendar event title
          type: string
        updated_at:
          description: Last modification time of the calendar event.
          example: 2023-04-13T15:34:06.989849Z
          format: date-time
          type: string
        user_guid:
          description: User GUID of the user calendar.
          example: 9ccb7701-52e7-4d3e-91b0-b142a2fef2ec
          type: string
    Call:
      properties:
        action:
          $ref: "#/components/schemas/EmbeddedResource"
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        called_person:
          $ref: "#/components/schemas/EmbeddedResource"
        created_at:
          description: Datetime of when the call was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_activity:
          $ref: "#/components/schemas/EmbeddedResource"
        disposition:
          description: Result of the call
          example: Connected
          type: string
        duration:
          description: Length of the call in seconds
          example: 60
          type: integer
        id:
          description: ID of Call
          example: 1
          type: integer
        note:
          $ref: "#/components/schemas/EmbeddedResource"
        recordings:
          description: The recordings for this this call and their status
          example:
            - recording_status: completed
              status: completed
              url: https://example.com/recording1
          items:
            $ref: "#/components/schemas/EmbeddedRecordingResource"
          type: array
        sentiment:
          description: Outcome of the conversation
          example: Demo Scheduled
          type: string
        step:
          $ref: "#/components/schemas/EmbeddedResource"
        to:
          description: Phone number that received the call
          example: "7705551234"
          type: string
        updated_at:
          description: Datetime of when the call was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    CallDataRecord:
      properties:
        call:
          $ref: "#/components/schemas/EmbeddedResource"
        call_type:
          description: "Type of the call. Can be one of: call, bridge, collaboration. Though exact values may change over time"
          example: call
          type: string
        call_uuid:
          description: UUID of the call. Legs of the same call will have the same call_uuid.
          example: 5c5c1f32-bff1-4b7c-8f2a-bd650b829c67
          type: string
        called_person:
          $ref: "#/components/schemas/EmbeddedResource"
        created_at:
          description: Datetime of when the call was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        direction:
          description: "Direction of the call. Can be one of: inbound, outbound"
          example: outbound
          type: string
        duration:
          description: Length of the call in seconds
          example: 60
          type: integer
        from:
          description: Phone number that placed the call
          example: "7705551234"
          type: string
        id:
          description: ID of CallDataRecord
          example: 1
          type: integer
        recording:
          $ref: "#/components/schemas/EmbeddedRecordingResource"
        status:
          description: "The outcome of the call. Can be one of: queued, initiated, ringing, in-progress, completed, busy, no-answer, canceled, failed"
          example: completed
          type: string
        to:
          description: Phone number that received the call
          example: "7705551234"
          type: string
        updated_at:
          description: Datetime of when the call was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    CallDisposition:
      properties:
        created_at:
          description: Datetime of when the call disposition was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of CallDisposition
          example: 1
          type: integer
        name:
          description: An available call disposition text
          example: Connected
          type: string
        updated_at:
          description: Datetime of when the call disposition was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    CallInstruction:
      properties:
        created_at:
          description: Datetime of when the call instructions were created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of call instructions
          example: 1
          type: integer
        instructions:
          description: The instructions
          example: Call once, leave voicemail if not answered. Conference conversation.
          type: string
        updated_at:
          description: Datetime of when the call instructions were last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    CallSentiment:
      properties:
        created_at:
          description: Datetime of when the call sentiment was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of CallSentiment
          example: 1
          type: integer
        name:
          description: An available call sentiment text
          example: Interested
          type: string
        updated_at:
          description: Datetime of when the call sentiment was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    CallerId:
      properties:
        account_name:
          description: The account of the person calling
          example: Bunty Soap Company
          type: string
        display_name:
          description: The name of the person calling
          example: Frank Galikanokus
          type: string
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        title:
          description: The title of the person calling
          example: Transportation Coordinator
          type: string
    ConversationsCall:
      properties:
        call_created_at:
          description: Timestamp for when the call started. If not provided, will default to the time the request was received
          example: 2022-07-22 01:00:00
          type: string
        direction:
          description: Call direction
          example: Outbound
          type: string
        duration:
          description: Duration of call in seconds
          example: 120
          type: number
        from:
          description: Phone number that call was made from
          example: 123-456-7890
          type: string
        recording:
          description: Object containing recording info including the audio file (.mp3, .wav, .ogg, .m4a)
          example:
            url: www.example.com/audio.mp3
          type: object
        to:
          description: Phone number that was called
          example: 123-456-7890
          type: string
        user_guid:
          description: Guid of the Salesloft User to assign the call to. If not provided, will default to the user within the authentication token
          example: aa111111-11aa-1111-a1a1-11aa11a1a1a1
          type: string
    CrmActivity:
      properties:
        activity_type:
          description: "The type of activity that is being recorded, if available. The values can change over time, but could be one of: email, phone, email reminder, inmail"
          example: phone
          type: string
        created_at:
          description: Datetime of when the crm activity was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_id:
          description: The ID of the activity in your CRM, if written to your CRM
          example: 00T0H00003w2FBhUAM
          type: string
        custom_crm_fields:
          description: Additional fields that are logged to your CRM, if mapped by the team at the time of writing to your CRM
          example:
            ecorp__Call_Type__c: inbound follow up
          type: object
        description:
          description: The description field of the activity in your CRM
          example: Timeline is 2 weeks for demo, set with Kate
          type: string
        error:
          description: Information about why this crm activity failed to sync, if it did fail to sync. Failed activities will be automatically retried and may become successful in the future
          example: Could not find a CRM account link.
          type: string
        id:
          description: CrmActivity ID
          example: 1
          type: integer
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        subject:
          description: The subject field of the activity in your CRM
          example: "Call: Connected | Interested"
          type: string
        updated_at:
          description: Datetime of when the crm activity was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    CrmActivityField:
      properties:
        created_at:
          description: Datetime of when the CrmActivityField was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_object_type:
          description: |
            The CRM object type that this field maps to. Valid object types are CRM dependent: Task, Phonecall, Email.
          example: Task
          type: string
        field:
          description: The CRM field name
          example: orgName__Field_Name__c
          type: string
        field_type:
          description: The type of this field in your CRM. Certain field types can only accept structured input.
          example: boolean
          type: string
        id:
          description: ID of CrmActivityField
          example: 1
          type: integer
        picklist_values:
          description: |
            Valid picklist values, if present for this field. The format is {label => value}. If present, only
            values in the picklist structure can be used as a crm param.
          example:
            High: High
            Low: Low
          type: object
        salesforce_object_type:
          description: |
            The Salesforce object type that this field maps to. Valid object types are: Task.
            More object types may be added in the future.
          example: Task
          type: string
        source:
          description: "SalesLoft object that this field is mapped for. Valid sources are: email, phone"
          example: phone
          type: string
        title:
          description: A human friendly title for this field
          example: Field Name
          type: string
        updated_at:
          description: Datetime of when the CrmActivityField was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        value:
          description: |
            A value to always be written. This value does not need to be sent to other endpoints' crm params,
            but must be the exact value if sent. Email source fields will always have a value present.
          example: Email
          type: string
    CrmUser:
      properties:
        created_at:
          description: Datetime of when the crm user was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_id:
          description: CRM ID
          example: 5003000000D8cuIQAA
          type: string
        id:
          description: Crm User ID
          example: 1
          type: integer
        updated_at:
          description: Datetime of when the crm user was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    CustomField:
      properties:
        created_at:
          description: Datetime of when the Custom Field was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        field_type:
          description: "Type of the Custom Field. Value must be one of: person, company, opportunity."
          example: person
          type: string
        id:
          description: ID of Custom Field
          example: 1
          type: integer
        name:
          description: Name of the Custom Field
          example: My Custom Field
          type: string
        updated_at:
          description: Datetime of when the Custom Field was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        value_type:
          description: "Value Type of the Custom Field. Value must be one of: text, date."
          example: text
          type: string
    CustomRole:
      properties:
        id:
          description: ID of the custom role
          example: "1"
          type: string
        name:
          description: Name of the custom role
          example: Test name
          type: string
    Email:
      properties:
        action:
          $ref: "#/components/schemas/EmbeddedResource"
        bounced:
          description: Whether this email bounced
          example: false
          type: boolean
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        click_tracking:
          description: Whether this email had click tracking enabled
          example: true
          type: boolean
        counts:
          $ref: "#/components/schemas/EmailCounts"
        created_at:
          description: Datetime of when the email was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_activity:
          $ref: "#/components/schemas/EmbeddedResource"
        email_template:
          $ref: "#/components/schemas/EmbeddedResource"
        error_message:
          description: Error message of the email. This field has been determined sensitive and requires a specific scope to access it.
          type: string
        headers:
          description: "Selected headers that are included if this email used them. Available keys are: cc, bcc"
          example:
            bcc: track@salesforce.com
            cc: sb@salesloft.com
          type: object
        id:
          description: ID of Email
          example: 1
          type: integer
        mailing:
          $ref: "#/components/schemas/EmbeddedResource"
        personalization:
          description: Percentage of this email that has been personalized
          example: "13.4"
          type: string
        recipient:
          $ref: "#/components/schemas/EmbeddedResource"
        recipient_email_address:
          description: Email address of the recipient
          example: bob.smith@example.com
          type: string
        send_after:
          description: When this email will be sent, or null if already sent
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        sent_at:
          description: When this email was sent, or null if it was not sent
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        status:
          description: "Status of this email through the sending process. Possible values are: sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external"
          example: sent
          type: string
        step:
          $ref: "#/components/schemas/EmbeddedResource"
        subject:
          description: Subject of the email. This field has been determined sensitive and requires a specific scope to access it.
          type: string
        task:
          $ref: "#/components/schemas/EmbeddedResource"
        updated_at:
          description: Datetime of when the email was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
        view_tracking:
          description: Whether this email had view tracking enabled
          example: true
          type: boolean
    EmailCounts:
      properties:
        attachments:
          description: The number of attachments on the email
          example: 0
          type: integer
        clicks:
          description: The number of times links in the email were clicked
          example: 2
          type: integer
        replies:
          description: The number of replies the email received
          example: 1
          type: integer
        unique_devices:
          description: The number of unique devices that opened the email
          example: 4
          type: integer
        unique_locations:
          description: The number of unique locations that opened the email
          example: 3
          type: integer
        views:
          description: The number of times the email was opened
          example: 3
          type: integer
    EmailTemplate:
      properties:
        _links:
          description: Links to attachments and tags resources for this email template.
          example:
            attachments: https://api.salesloft.com/v2/email_template_attachments?email_template_id[]=1
          type: object
        archived_at:
          description: Datetime of when the email template was archived, if archived
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        body:
          description: Sanitized body of the email template without email signature
          example: <div><div>Welcome to the SalesLoft family! My name is Sarah and I’m your implementation consultant. I’m here to get you up and running. It's my job to help you configure your team's SalesLoft access, provide customized training for your specific goals, and make sure that you and your team are ready to crush your goals.</div><div dir="ltr"><br></div>Thank you,<br></div>
          type: string
        body_preview:
          description: A plain text version of the first 100 characters of the body of the email template
          example: |-
            hello

            hey sounds good

            ok

            ok

            with an edit

            ok now i'm comic sans 14
          type: string
        cadence_template:
          description: Whether this email template is only used on a cadence step. These templates are not visible in the SalesLoft application template list. If false, this email template is visible in the SalesLoft application, and may be used when composing an email or creating a cadence step.
          example: true
          type: boolean
        click_tracking_enabled:
          description: Whether click tracking is enabled for this email template
          example: true
          type: boolean
        counts:
          $ref: "#/components/schemas/EmailTemplateCounts"
        created_at:
          description: Datetime of when the email template was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        groups:
          description: Groups to which this template is assigned, if any
          example:
            - _href: https://api.salesloft.com/v2/groups/921
              id: 921
          items:
            $ref: "#/components/schemas/EmbeddedResource"
          type: array
        id:
          description: ID of email template
          example: 5
          type: integer
        last_used_at:
          description: Datetime of when the email template was last used
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        open_tracking_enabled:
          description: Whether open tracking is enabled for this email template
          example: true
          type: boolean
        shared:
          description: Whether this email template is visible to team members (shared)
          example: false
          type: boolean
        subject:
          description: Subject of the email template
          example: Welcome to SalesLoft!
          type: string
        tags:
          description: All tags applied to this email template
          example:
            - 7-23-2017
            - internal
          items:
            type: string
          type: array
        team_template:
          $ref: "#/components/schemas/EmbeddedResource"
        template_owner:
          $ref: "#/components/schemas/EmbeddedResource"
        title:
          description: Title of the email template
          example: Welcome email
          type: string
        updated_at:
          description: Datetime of when the email template was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    EmailTemplateAttachment:
      properties:
        attachment_content_type:
          description: Content type of the attachment
          example: pdf, jpeg
          type: string
        attachment_file_size:
          description: The size of the attachment
          example: 2
          type: integer
        attachment_fingerprint:
          description: Unique attachment Identifier
          example: 13231232
          type: integer
        attachment_id:
          description: ID of the email template attachment
          example: 10
          type: integer
        download_url:
          description: Download url of the attachment
          example: https://path/to/example_attachment.gif
          type: string
        email_template:
          $ref: "#/components/schemas/EmbeddedResource"
        id:
          description: ID of email template attachment association
          example: 5
          type: integer
        name:
          description: Name of the attachment
          example: example_attachment.gif
          type: string
        scanned:
          description: Checks if attachment has been scanned
          example: true
          type: boolean
    EmailTemplateCounts:
      properties:
        bounces:
          description: The number of bounces the email template received
          example: 10
          type: integer
        clicks:
          description: The number of times links in the email template were clicked
          example: 20
          type: integer
        replies:
          description: The number of replies the email template received
          example: 1
          type: integer
        sent_emails:
          description: The number of times the email template was sent out
          example: 59
          type: integer
        views:
          description: The number of times the email template was opened
          example: 3
          type: integer
    EmbeddedAccountCounts:
      properties:
        people:
          description: Number of people in SalesLoft associated with this Account
          example: 15
          type: integer
    EmbeddedAttendeeResource:
      properties:
        deleted_at:
          description: Datetime of when the attendee was deleted
          example: 2022-12-19T16:49:17.930926+02:00
          format: date
          type: string
        email:
          description: Email of the attendee
          example: calendar@example.com
          type: string
        name:
          description: Name of the attendee
          example: John
          type: string
        organizer:
          description: Whether the attendee is the organizer of the event.
          example: false
          type: boolean
        status:
          description: "The attendee's response status. Possible values are: needsAction, accepted, tentative, declined"
          example: accepted
          type: string
        status_changed:
          description: Whether the attendee changed response status
          example: false
          type: boolean
    EmbeddedRecordingResource:
      properties:
        recording_status:
          description: |
            The processing status of the recording. Possible values are (but not limited to):

            not_recorded: there is no recording available, and there will not be one becoming available

            pending: the recording is currently being processed by the system

            processing: the recording is currently being processed by the system

            completed: the recording processing has been completed
          example: completed
          type: string
        status:
          description: |
            The status of the call that produced this recording. Possible values are (but not limited to):

            no-answer: The call was not answered

            failed: The call was not able to be placed

            busy: The call was busy

            ringing: The call is ringing

            in-progress: The call is ongoing

            completed: The call is finished
          example: completed
          type: string
        url:
          description: The url of the recording
          example: http://example.com/recording/1
          type: string
    EmbeddedResource:
      properties:
        _href:
          description: Resource URL, pointed at your API version, present if this resource is available in the API
          example: https://api.salesloft.com/v2/widgets/10
          type: string
        id:
          description: ID of the resource
          example: 10
          type: integer
    EventMeetingSetting:
      properties:
        email_address:
          description: Calendar owner's email address
          example: calendar.owner@example.com
          type: string
    ExternalEmail:
      properties:
        message_id:
          description: Message id present in the External Email header
          example: CAKseEdbTMcU-U0CeTkUSo5X4jyW8QPReVTyPA6CrUCf0ggZwHQ@mail.salesloft.com
          type: string
    Group:
      properties:
        accessible_groups:
          description: Groups accessible if any
          example:
            - _href: https://api.salesloft.com/v2/groups/921
              id: 921
          items:
            $ref: "#/components/schemas/EmbeddedResource"
          type: array
        id:
          description: ID of the Group
          example: 1
          type: integer
        name:
          description: Name of the Group
          example: Test name
          type: string
        parent_id:
          description: ID of the parent Group
          example: 2
          type: integer
    Import:
      properties:
        created_at:
          description: Datetime of when the import was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        current_people_count:
          description: Count of People that have not been deleted
          example: 5
          type: integer
        id:
          description: Import ID
          example: 1
          type: integer
        imported_people_count:
          description: Count of People that have ever been on this Import
          example: 7
          type: integer
        name:
          description: Name of Import
          example: DataProvider -> SalesLoft 9/1/17
          type: string
        updated_at:
          description: Datetime of when the import was last updated, ignoring relationship changes
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    JobData:
      properties:
        bulk_job:
          description: Associated bulk job
          example: '{"id": 123, "_href": "https://api.salesloft.com/v2/bulk_jobs/123"'
          type: object
        created_at:
          description: When this job data record was created
          example: 2019-01-01T00:00:00-05:00
          format: date-time
          type: string
        error:
          description: Error associated with this record
          example: Not found
          type: string
        finished_at:
          description: When this job data record finished processing
          example: 2019-01-01T00:00:00-05:00
          format: date-time
          type: string
        id:
          description: ID of this Job Data
          example: 1
          type: integer
        record:
          description: The data that was used to process the operation
          example: '{first_name: "John", last_name: "Smith"}'
          type: object
        resource:
          description: The object containing the resulting resource from performing the bulk action on this record
          example: '{person: {...}, upsert_type: "create"}'
          type: object
        started_at:
          description: When this job data record started processing
          example: 2019-01-01T00:00:00-05:00
          format: date-time
          type: string
        status:
          description: "Status of this job data. Must be one of: pending, success, error, retrying"
          example: success
          type: string
    JobDataCreationResult:
      properties:
        records:
          description: Number of records created
          example: 100
          type: integer
    LiveFeedItem:
      properties:
        alert_metadata:
          description: Information about whether this event should trigger an alert
          example:
            should_alert: true
            should_alert_until: 2019-01-01T00:00:00-05:00
          type: object
        event_occurred_at:
          description: When this event occurred
          example: 2019-01-01T00:00:00-05:00
          format: date-time
          type: string
        event_type:
          description: The type of event
          example: email_click
          type: string
        id:
          description: ID of this item
          example: 1
          type: integer
        message:
          description: A plaintext message for this event
          example: Steve is visiting your website.
          type: string
        metadata:
          description: The metadata created for this event
          example:
            email_id: 2
            email_subject: Come join us at Rainmaker, Jon!
            mailing_id: 3
            person_id: 1
          type: object
        path:
          description: The path to the application that should be followed
          example: /app/emails/detail/1
          type: string
        rollup_key:
          description: The key that should be used to rollup events client side. null or empty values should not be rolled up
          example: email_click:10
          type: string
        title:
          description: A plaintext title for this event
          example: Website Visit
          type: string
        user_guid:
          description: UUID of the user this item is for
          example: 51398ccd-309e-467f-aae2-4b0f66b5c11d
          type: string
    LiveWebsiteTrackingParameter:
      properties:
        parameters:
          description: A SalesLoft identifier
          example:
            - name: sbrc
              value: tracking parameter
          items:
            type: object
          type: array
    Meeting:
      properties:
        account_id:
          description: ID of the account the recipient associated to
          example: "1"
          type: string
        all_day:
          description: Whether the meeting is an all-day meeting
          example: false
          type: boolean
        attendees:
          description: "The attendees of the meeting. Each attendee includes the following fields: status, email, name, organizer"
          example:
            - deleted_at: null
              email: john@example.com
              name: John
              organizer: true
              status: accepted
          items:
            $ref: "#/components/schemas/EmbeddedAttendeeResource"
          type: array
        booked_by_meetings_settings:
          $ref: "#/components/schemas/EventMeetingSetting"
        booked_by_user:
          $ref: "#/components/schemas/EmbeddedResource"
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        calendar_id:
          description: Calendar ID of the meeting owner
          example: calendar-id-google.com
          type: string
        calendar_type:
          description: "Calendar type of the meeting owner. Possible values are: gmail, azure, nylas, linkedin_azure, cerebro, external"
          example: gmail
          type: string
        canceled_at:
          description: Datetime of when the meeting was canceled
          example: 2022-12-19T16:49:17.931396+02:00
          format: date
          type: string
        created_at:
          description: Datetime of when the meeting was created
          example: 2022-12-19T16:49:17.930298+02:00
          format: date
          type: string
        crm_custom_fields:
          description: List of crm custom fields which will be logged to SFDC
          example:
            Event_Calendar_Type__c: Google
          type: object
        crm_references:
          description: List of crm references associated with the meeting
          example:
            what:
              crm_id: 0063X000018fDmMQAU
              crm_object_label: Opportunity
              crm_object_type: Opportunity
              crm_url: link_to_salesforce
              description1: Title of the opportunity
              description2: 2032-01-10
              description3: Prospecting
            who:
              crm_id: 0033X00004GOywtQAD
              crm_object_label: Contact
              crm_object_type: Contact
              crm_url: link_to_salesforce
              description1: John Doe
              description2: john.doe@example.com
              description3: null
          type: object
        description:
          description: Description of the meeting
          example: Introducing interview
          type: string
        end_time:
          description: End time of the meeting
          example: 2022-12-19T16:49:17.917861+02:00
          format: date
          type: string
        event_id:
          description: ID of the meeting created by target calendar
          example: "123468796"
          type: string
        event_source:
          description: "Source of the meeting. Possible values are: 'external' - The event was synced to Salesloft platform via Calendar Sync, 'internal' - The event was created via Salesloft platform"
          example: external
          type: string
        guests:
          description: The list of attendees emails of the meeting
          example:
            - email1@sloft.com
            - email2@sloft.com
          items:
            type: string
          type: array
        i_cal_uid:
          description: UID of the meeting provided by target calendar provider
          example: 040P00B08200E00074C5B7101A82EF
          type: string
        id:
          description: ID of the meeting
          example: 1
          type: integer
        location:
          description: Location of the meeting
          example: Atlanta, GA
          type: string
        meeting_type:
          description: Meeting type
          example: Demo call
          type: string
        no_show:
          description: Whether the meeting is a No Show meeting
          example: false
          type: boolean
        owned_by_meetings_settings:
          $ref: "#/components/schemas/EventMeetingSetting"
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        recipient_email:
          description: Email of the meeting invite recipient
          example: email@sloft.com
          type: string
        recipient_name:
          description: Name of the meeting invite recipient
          example: John Doe
          type: string
        reschedule_status:
          description: "Status of the meeting rescheduling progress. Possible values are: pending, booked, failed, retry"
          example: booked
          type: string
        start_time:
          description: Start time of the meeting
          example: 2022-12-19T16:49:17.917818+02:00
          format: date
          type: string
        status:
          description: "Status of the meeting. Possible values are: pending, booked, failed, retry"
          example: booked
          type: string
        step:
          $ref: "#/components/schemas/EmbeddedResource"
        strict_attribution:
          description: Strict attribution means that we 100% sure which cadence generate the meeting
          example: false
          type: boolean
        task_id:
          description: ID of the created task
          example: "123"
          type: string
        title:
          description: Title of the meeting
          example: Meeting with John
          type: string
        updated_at:
          description: Datetime of when the meeting was last updated
          example: 2022-12-19T16:49:17.930340+02:00
          format: date
          type: string
    MeetingSetting:
      properties:
        active_meeting_url:
          $ref: "#/components/schemas/MeetingUrl"
        allow_booking_on_behalf:
          description: Allow other team members to schedule on you behalf.
          example: true
          type: boolean
        allow_booking_overtime:
          description: Allow team members to insert available time outside your working hours.
          example: true
          type: boolean
        allow_event_overlap:
          description: Allow team members to double book events on your calendar.
          example: false
          type: boolean
        availability_limit:
          description: The number of days out the user allows a prospect to schedule a meeting
          example: 14
          type: integer
        availability_limit_enabled:
          description: If Availability Limits have been turned on
          example: true
          type: boolean
        buffer_time_duration:
          description: Default buffer duration in minutes set by a user
          example: "15"
          type: integer
        calendar_type:
          description: Calendar type
          example: gmail
          type: string
        created_at:
          description: Datetime of when the MeetingSetting was created
          example: 2022-09-15T11:40:59.055583+03:00
          format: date
          type: string
        default_meeting_length:
          description: Default meeting length in minutes set by the user
          example: "30"
          type: integer
        description:
          description: Default description of the meeting
          example: This meeting is held on a daily basis
          type: string
        email_address:
          description: Calendar owner's email address
          example: calendar.owner@example.com
          type: string
        enable_calendar_sync:
          description: Determines if a user enabled Calendar Sync feature
          example: false
          type: boolean
        enable_dynamic_location:
          description: Determines if location will be filled via third-party service (Zoom, GoToMeeting, etc.)
          example: false
          type: boolean
        id:
          description: ID of the MeetingSetting
          example: 1
          type: integer
        location:
          description: Default location of the meeting
          example: Atlanta, GA
          type: string
        primary_calendar_connection_failed:
          description: Gets true when any issue with fetching calendar occurs
          example: false
          type: boolean
        primary_calendar_id:
          description: ID of the primary calendar
          example: a98iu0@group.calendar.google.com
          type: string
        primary_calendar_name:
          description: Display name of the primary calendar
          example: My Meetings Calendar
          type: string
        reschedule_meetings_enabled:
          description: Determines if a user enabled reschedule meetings feature
          example: false
          type: boolean
        schedule_buffer_enabled:
          description: Determines if meetings are scheduled with a 15 minute buffer between them
          example: true
          type: boolean
        schedule_delay:
          description: The number of hours in advance a user requires someone to a book a meeting with them
          example: 2
          type: integer
        share_event_detail:
          description: Allow team members to see the details of events on your calendar.
          example: false
          type: boolean
        time_zone:
          description: Time zone for current calendar
          example: US/Eastern
          type: string
        times_available:
          description: Times available set by a user that can be used to book meetings
          example:
            monday:
              enabled: true
              end_time: 17:00
              start_time: 09:00
          type: object
        title:
          description: Default title of the meeting
          example: Daily stand-up
          type: string
        updated_at:
          description: Datetime of when the MeetingSetting was last updated
          example: 2022-09-15T11:40:59.055628+03:00
          format: date
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
        user_details:
          description: User details
          example:
            email: john.doe@salesloft.com
            name: John Doe
          type: object
        user_slug:
          description: User slug generated with a full name of the user
          example: john-doe
          type: string
    MeetingUrl:
      properties:
        created_at:
          description: Datetime of when MeetingUrl was created
          example: 2022-09-15T11:40:59.056237+03:00
          format: date
          type: string
        updated_at:
          description: Datetime of when MeetingUrl was last updated
          example: 2022-09-15T11:40:59.056272+03:00
          format: date
          type: string
        url:
          description: Full url of the meeting
          example: https://example.com/team/user
          type: string
    MimeEmailPayload:
      properties:
        id:
          description: Email ID
          example: 1
          type: integer
        mailbox:
          description: Email Address of Sender's mailbox
          example: example@salesloft.com
          type: string
        message_id:
          description: Unique Message ID
          example: CAKseEdbTMcU-U0CeTkUSo5X4jyW8QPReVTyPA6CrUCf0ggZwHQ@mail.salesloft.com
          type: string
        raw:
          description: Base64 encoded MIME email content
          example: |
            ZW1haWwgZXhhbXBsZQ==
          type: string
    Note:
      properties:
        associated_type:
          description: Type of associated resource ('person' or 'account')
          example: person
          type: string
        associated_with:
          $ref: "#/components/schemas/EmbeddedResource"
        call:
          $ref: "#/components/schemas/EmbeddedResource"
        content:
          description: The content of the note
          example: Was very interested in a demo at a later time
          type: string
        created_at:
          description: Datetime of when the note was created
          example: 2022-01-01T00:00:00.000000-06:00
          format: date-time
          type: string
        id:
          description: Note ID
          example: 1
          type: integer
        updated_at:
          description: Datetime of when the note was last updated
          example: 2022-01-01T00:00:00.000000-06:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    PendingEmail:
      properties:
        id:
          description: ID of the email
          example: 1
          type: integer
        mailbox:
          description: Email Address of the pending email
          example: example@salesloft.com
          type: string
        mime_email_payload:
          $ref: "#/components/schemas/EmbeddedResource"
    Person:
      properties:
        account:
          $ref: "#/components/schemas/EmbeddedResource"
        bouncing:
          description: Whether this person's current email address has bounced
          example: false
          type: boolean
        cadences:
          description: The list of active cadences person is added to
          example:
            - _href: https://api.salesloft.com/v2/cadences/1
              id: 1
          items:
            $ref: "#/components/schemas/EmbeddedResource"
          type: array
        city:
          description: City
          example: Atlanta
          type: string
        contact_restrictions:
          description: "Specific methods of communication to prevent for this person. This will prevent individual execution of these communication types as well as automatically skip cadence steps of this communication type for this person in SalesLoft. Values currently accepted: call, email, message"
          example:
            - call
            - email
            - message
          items:
            type: string
          type: array
        country:
          description: Country
          example: United States
          type: string
        counts:
          $ref: "#/components/schemas/PersonCounts"
        created_at:
          description: Datetime of when the person was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_id:
          description: CRM ID
          example: 003i000001mnhpD
          type: string
        crm_object_type:
          description: CRM object type
          example: Lead
          type: string
        crm_url:
          description: CRM url
          example: https://na15.salesforce.com/003i000001mnhpD
          type: string
        custom_fields:
          description: Custom fields are defined by the user's team. Only fields with values are presented in the API.
          example:
            MyField: A Value
            Other: Field
          type: object
        display_name:
          description: Either the full name or the email address. Use this when showing a person's name
          example: Pat Johnson
          type: string
        do_not_contact:
          description: Whether or not this person has opted out of all communication. Setting this value to true prevents this person from being called, emailed, or added to a cadence in SalesLoft. If this person is currently in a cadence, they will be removed.
          example: true
          type: boolean
        email_address:
          description: Email address
          example: pat.johnson@example.com
          type: string
        eu_resident:
          description: Whether this person is marked as a European Union Resident or not
          example: false
          type: boolean
        first_name:
          description: First name
          example: Pat
          type: string
        full_email_address:
          description: Full email address with name
          example: Pat Johnson <pat.johnson@example.com>
          type: string
        home_phone:
          description: Home phone without formatting
          example: +1 444 555 6666
          type: string
        id:
          description: Person ID
          example: 1
          type: integer
        import:
          $ref: "#/components/schemas/EmbeddedResource"
        job_seniority:
          description: The Job Seniority of a Person, must be one of director, executive, individual_contributor, manager, vice_president, unknown
          example: vice_president
          type: string
        last_completed_step:
          $ref: "#/components/schemas/EmbeddedResource"
        last_completed_step_cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        last_contacted_at:
          description: Last datetime this person was contacted
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        last_contacted_by:
          $ref: "#/components/schemas/EmbeddedResource"
        last_contacted_type:
          description: The type of the last touch to this person. Can be call, email, other
          example: call
          type: string
        last_name:
          description: Last name
          example: Johnson
          type: string
        last_replied_at:
          description: Last datetime this person replied to an email
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        linkedin_url:
          description: Linkedin URL
          example: https://www.linkedin.com/in/username
          type: string
        locale:
          description: Time locale of the person
          example: US/Eastern
          type: string
        locale_utc_offset:
          description: The locale's timezone offset from UTC in minutes
          example: -480
          type: integer
        mobile_phone:
          description: Mobile phone without formatting
          example: +1 444 555 6666
          type: string
        most_recent_cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        owner:
          $ref: "#/components/schemas/EmbeddedResource"
        owner_crm_id:
          description: Mapped owner field from your CRM
          example: 003i000001mnhpD
          type: string
        person_company_industry:
          description: Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
          example: Information Technology
          type: string
        person_company_name:
          description: Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
          example: SalesLoft
          type: string
        person_company_website:
          description: Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended
          example: https://salesloft.com
          type: string
        person_stage:
          $ref: "#/components/schemas/EmbeddedResource"
        personal_email_address:
          description: Personal email address
          example: pat.johnson@example.com
          type: string
        personal_website:
          description: The website of this person
          example: https://salesloft.com
          type: string
        phone:
          description: Phone without formatting
          example: +1 444 555 6666
          type: string
        phone_extension:
          description: Phone extension without formatting
          example: x123
          type: string
        secondary_email_address:
          description: Alternate email address
          example: pat.johnson@example.com
          type: string
        starred:
          description: Whether this person is starred by the current user
          example: true
          type: boolean
        state:
          description: State
          example: Georgia
          type: string
        success_count:
          description: The person's success count. 1 if person has any active successes, 0 otherwise.
          example: 1
          type: integer
        tags:
          description: All tags applied to this person
          example:
            - 7-23-2017
            - dreamforce
          items:
            type: string
          type: array
        title:
          description: Job title
          example: Sales Development Representative
          type: string
        twitter_handle:
          description: The twitter handle of this person
          example: "@kyleporter"
          type: string
        untouched:
          description: The person's untouched status
          example: false
          type: boolean
        updated_at:
          description: Datetime of when the person was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        work_city:
          description: Work location - city
          example: Atlanta
          type: string
        work_country:
          description: Work location - country
          example: United States
          type: string
        work_state:
          description: Work location - state
          example: Georgia
          type: string
    PersonCounts:
      properties:
        calls:
          description: The number of calls logged to this person
          example: 4
          type: integer
        emails_bounced:
          description: The number of unique emails sent to this person that bounced
          example: 0
          type: integer
        emails_clicked:
          description: The number of unique emails clicked by this person
          example: 1
          type: integer
        emails_replied_to:
          description: The number of unique emails replied to by this person
          example: 0
          type: integer
        emails_sent:
          description: The number of emails sent to this person
          example: 3
          type: integer
        emails_viewed:
          description: The number of unique emails viewed by this person
          example: 2
          type: integer
    PersonStage:
      properties:
        created_at:
          description: Datetime of when the Person Stage was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of Person Stage
          example: 1
          type: integer
        name:
          description: Name of Person Stage
          example: Entry Stage
          type: string
        order:
          description: Sortable value of Person Stage order
          example: 16
          type: integer
        updated_at:
          description: Datetime of when the Person Stage was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    PersonUpsert:
      properties:
        person:
          $ref: "#/components/schemas/Person"
        upsert_type:
          description: "The type of upsert. One of: create, update"
          type: string
    PhoneNumberAssignment:
      properties:
        id:
          description: PhoneNumberAssignment ID
          example: 1
          type: integer
        number:
          description: The phone number associated with this assignment
          example: "+12223334444"
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    RecordingSetting:
      properties:
        recording_default:
          description: Whether this phone number should record by default
          example: true
          type: boolean
    SavedListView:
      properties:
        id:
          description: ID of Ssaved list view
          example: 1
          type: integer
        is_default:
          description: Whether the saved list view is the default view
          example: true
          type: boolean
        name:
          description: Name of saved list view
          example: Tom's Prospects
          type: string
        view:
          description: Type of saved list view
          example: companies
          type: string
        view_params:
          description: List of set filters in saved list view
          example:
            owner: unowned
            stage: "28865"
            unowned: true
          type: object
    Step:
      properties:
        cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        created_at:
          description: Datetime of when the Step was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        day:
          description: Day this step is associated with up
          example: 1
          type: integer
        details:
          $ref: "#/components/schemas/EmbeddedResource"
        disabled:
          description: Whether this step is currently active
          example: true
          type: boolean
        display_name:
          description: Display name of the step
          example: "Day 1: Step 2 - Phone"
          type: string
        id:
          description: ID of Step
          example: 1
          type: integer
        multitouch_enabled:
          description: Whether this step is a multitouch cadence step
          example: false
          type: boolean
        name:
          description: Name of the step
          example: VP Email Short
          type: string
        step_number:
          description: The number of the step for this day
          example: 1
          type: integer
        type:
          description: |
            The type of the action scheduled by this step. Valid types are: email, phone, integration, other. New types may be added in the future.
          example: phone
          type: string
        updated_at:
          description: Datetime of when the Step was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    Subscription:
      properties:
        callback_token:
          description: SalesLoft will include this token in the webhook event payload when calling your callback_url. It is strongly encouraged for your handler to verify this value in order to ensure the request came from SalesLoft.
          example: xT7/Buu0Vz2ffiIPuMlBGu+cwku1dr7G5jeiM0iyfYIT0l4z3azNGjiXWTOX/8OT
          type: string
        callback_url:
          description: URL for your callback handler
          example: https://mycompany.com/api/person_called_handler
          type: string
        enabled:
          description: Is the Webhook Subscription enabled or not
          example: true
          type: boolean
        event_type:
          description: Type of event the subscription is for
          example: link_swap
          type: string
        id:
          description: ID for the Webhook Subscription
          example: 1
          type: integer
        tenant_id:
          description: ID for the tenant to which user is assigned
          example: 16
          type: integer
        user_guid:
          description: UUID of the user the token is associated with
          example: 51398ccd-309e-467f-aae2-4b0f66b5c11d
          type: string
    Success:
      properties:
        counts:
          $ref: "#/components/schemas/SuccessCounts"
        created_at:
          description: Datetime of when the success was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of success
          example: 1
          type: integer
        latest_action:
          $ref: "#/components/schemas/EmbeddedResource"
        latest_cadence:
          $ref: "#/components/schemas/EmbeddedResource"
        latest_call:
          $ref: "#/components/schemas/EmbeddedResource"
        latest_email:
          $ref: "#/components/schemas/EmbeddedResource"
        latest_step:
          $ref: "#/components/schemas/EmbeddedResource"
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        succeeded_at:
          description: Datetime of when the success was recorded
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        success_window_started_at:
          description: Datetime of when this person was first worked, leading up to the success
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        updated_at:
          description: Datetime of when the success was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    SuccessCounts:
      properties:
        total_calls:
          description: The total number of calls made in this success window
          example: 5
          type: integer
        total_emails:
          description: The total number of emails made in this success window
          example: 2
          type: integer
        total_other_touches:
          description: The total number of other touches made in this success window
          example: 3
          type: integer
    Tag:
      properties:
        id:
          description: ID of Tag
          example: 1
          type: integer
        name:
          description: Name of the tag
          example: marketing
          type: string
    Task:
      properties:
        completed_at:
          description: Datetime of when the task was completed, ISO-8601 datetime format required
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        completed_by:
          $ref: "#/components/schemas/EmbeddedResource"
        created_at:
          description: Datetime of when the Task was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        created_by_user:
          $ref: "#/components/schemas/EmbeddedResource"
        current_state:
          description: "The state of the task. Valid states are: scheduled, completed"
          example: scheduled
          type: string
        description:
          description: A description of the task recorded for person at completion time
          example: Ask John Wick about his dog.
          type: string
        due_at:
          description: Datetime of when the Task is due, can be null.  ISO-8601 datetime format required
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        due_date:
          description: Date of when the Task is due, ISO-8601 date format required
          example: 2024-01-01
          format: date
          type: string
        id:
          description: ID of Task
          example: 1
          type: integer
        person:
          $ref: "#/components/schemas/EmbeddedResource"
        remind_at:
          description: Datetime of when the user will be reminded of the task, ISO-8601 datetime format required
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        subject:
          description: Subject line of the task
          example: Call John Wick
          type: string
        task_type:
          description: "The type of the task.  Valid types are: call, email, general"
          example: call
          type: string
        updated_at:
          description: Datetime of when the Task was last updated
          example: 2022-01-01T00:00:00.000000-08:00
          format: date-time
          type: string
        user:
          $ref: "#/components/schemas/EmbeddedResource"
    Team:
      properties:
        _private_fields:
          description: For internal use only. This field does not comply with our backwards compatability policies.
          example: {}
          type: object
        allow_automated_email_steps:
          description: Whether team members are allowed to have automated email steps
          example: true
          type: boolean
        call_recording_disabled:
          description: Whether all call recording is disabled
          example: false
          type: boolean
        click_tracking_default:
          description: The team default for click tracking when composing emails
          example: true
          type: boolean
        created_at:
          description: Datetime of when the team was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        custom_tracking_domain:
          description: The domain click and open tracking will be proxied through
          example: examplecompany.com
          type: string
        deactivated:
          description: Indicates if the team has been deactivated
          example: true
          type: boolean
        dispositions_required:
          description: Whether team members are required to mark disposition at the end of calls
          example: false
          type: boolean
        email_daily_limit:
          description: Daily email limit for each member on the team
          example: 1000
          type: integer
        group_privacy_setting:
          description: |
            Visibility setting for resources across the team. Possible values are: group_public, all_public.
            When the value is group_public, certain resources will only be visible to members of the same group.
            When the value is all_public, all resources are visible to all users on this team.
          example: all_public
          type: string
        id:
          description: Team ID
          example: 1
          type: integer
        license_limit:
          description: Count of seats that this team has licensed
          example: 100
          type: integer
        local_dial_enabled:
          description: Whether this team has local dial enabled
          example: true
          type: boolean
        name:
          description: Team name
          example: The A-Team
          type: string
        plan:
          description: "Plan type of the team, Possible values are: group, professional, enterprise"
          example: professional
          type: string
        plan_features:
          description: Add on features for this team
          example:
            opportunity_management: Opportunity Management
          type: object
        record_by_default:
          description: Whether calls will record by default
          example: true
          type: boolean
        sentiments_required:
          description: Whether team members are required to log sentiments
          example: false
          type: boolean
        team_visibility_default:
          description: |
            The default visibility of resources on the team, in the UI only. The API does not utilize this default.
            Possible values are: public, private.
          example: public
          type: string
        updated_at:
          description: Datetime of when the team was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    TeamTemplate:
      properties:
        _links:
          description: "Links to attachments resource for this template "
          example:
            attachments: https://api.salesloft.com/v2/team_template_attachments?team_template_id[]=1
          type: object
        archived_at:
          description: Datetime of when the team template was archived, if archived
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        body:
          description: Body of the team template
          example: <div>Do you know about birds?</div><div>You can find them here: <a href="https://www.allaboutbirds.org/guide/search/" target="_blank">https://www.allaboutbirds.org/guide/search/</a></div>
          type: string
        body_preview:
          description: A plain text version of the first 100 characters of the body of the team template
          example: |-
            hello

            hey sounds good

            ok

            ok

            with an edit

            ok now i'm comic sans 14
          type: string
        click_tracking_enabled:
          description: Whether click tracking is enabled for this team template
          example: true
          type: boolean
        counts:
          $ref: "#/components/schemas/TeamTemplateCounts"
        created_at:
          description: Datetime of when the team template was created
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        id:
          description: ID of team template
          example: 51226150-3108-4dea-883b-0c0d7388f456
          type: string
        last_modified_at:
          description: Datetime of when the team template was last modified
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        last_modified_user:
          $ref: "#/components/schemas/EmbeddedResource"
        last_used_at:
          description: Datetime of when the team template was last used
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        open_tracking_enabled:
          description: Whether open tracking is enabled for this team template
          example: true
          type: boolean
        subject:
          description: Subject of the team template
          example: It’s time to say goodbye
          type: string
        tags:
          description: All tags applied to this team template
          example:
            - 7-23-2017
            - internal
          items:
            type: string
          type: array
        title:
          description: Title of the team template
          example: VP Breakup Email
          type: string
        updated_at:
          description: Datetime of when the team template was last updated
          example: 2022-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
    TeamTemplateAttachment:
      properties:
        attachment_file_size:
          description: The size of the attachment
          example: 2
          type: integer
        attachment_id:
          description: ID of the team template attachment
          type: integer
        download_url:
          description: Download url of the attachment
          example: https://path/to/example_attachment.gif
          type: string
        id:
          description: ID of team template attachment association
          example: 5
          type: integer
        name:
          description: Name of the attachment
          example: example_attachment.gif
          type: string
        team_template:
          $ref: "#/components/schemas/EmbeddedResource"
    TeamTemplateCounts:
      properties:
        bounces:
          description: The number of bounces the team template received
          example: 10
          type: integer
        clicks:
          description: The number of times links in the team template were clicked
          example: 20
          type: integer
        replies:
          description: The number of replies the team template received
          example: 1
          type: integer
        sent_emails:
          description: The number of times the team template was sent out
          example: 59
          type: integer
        views:
          description: The number of times the team template was opened
          example: 3
          type: integer
    User:
      properties:
        _private_fields:
          description: For internal use only. This field does not comply with our backwards compatability policies.
          example: {}
          type: object
        active:
          description: Whether an user is currently active in SalesLoft
          example: true
          type: boolean
        bcc_email_address:
          description: Address that will be BBC'd on all emails from this user
          example: fake@salesloft.com
          type: string
        click_to_call_enabled:
          description: Whether this user has click to call enabled
          example: true
          type: boolean
        created_at:
          description: Datetime of when the user was created
          example: 2023-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        crm_connected:
          description: Whether the user has a crm connected
          example: true
          type: boolean
        email:
          description: Email address provided to accounts.salesloft.com
          example: fake@salesloft.com
          type: string
        email_client_configured:
          description: Whether this user has a email client configured
          example: true
          type: boolean
        email_client_email_address:
          description: Email address associated with the email client of the user
          example: fake@salesloft.com
          type: string
        email_signature:
          description: Email signature
          example: Benjamin Franklin<div></div><div></div>
          type: string
        email_signature_click_tracking_disabled:
          description: Whether this user has click tracking disabled in email signature
          example: false
          type: boolean
        email_signature_type:
          description: Email signature type
          example: html
          type: string
        external_feature_flags:
          description: Feature flags that are for this user. New flags may appear or disappear at any time
          example: {}
          type: object
        first_name:
          description: First name of user
          example: Benjamin
          type: string
        from_address:
          description: The from address of this user
          example: fake@salesloft.com
          type: string
        full_email_address:
          description: RFC 5322 compliant email address
          example: '"Benjamin Franklin" <Benjamin@salesloft.com>'
          type: string
        group:
          $ref: "#/components/schemas/EmbeddedResource"
        guid:
          description: Globally unique user ID. New endpoints will explicitly accept this over id
          example: 9cc6da15-d403-4f5b-aeed-c4b8463cf9ae
          type: string
        id:
          description: User ID
          example: 1
          type: integer
        job_role:
          description: Job role of user
          example: SDR / BDR
          type: string
        last_name:
          description: Last name of user
          example: Franklin
          type: string
        local_dial_enabled:
          description: Whether this user has Local Dial enabled
          example: true
          type: boolean
        name:
          description: Display name of user
          example: Benjamin Franklin
          type: string
        phone_client:
          $ref: "#/components/schemas/EmbeddedResource"
        phone_number_assignment:
          $ref: "#/components/schemas/EmbeddedResource"
        role:
          $ref: "#/components/schemas/EmbeddedResource"
        sending_email_address:
          description: "The email address that email of the user will be sent from, resolved in the following resolution order: from_user, email_client_email_address, email"
          example: fake@salesloft.com
          type: string
        slack_username:
          description: Slack username
          example: benjamin-franklin
          type: string
        team:
          $ref: "#/components/schemas/EmbeddedResource"
        team_admin:
          description: Team Admin
          example: true
          type: boolean
        time_zone:
          description: User Time Zone
          example: US/Eastern
          type: string
        twitter_handle:
          description: Twitter handle
          example: "@benjamin-franklin"
          type: string
        updated_at:
          description: Datetime of when the user was last updated
          example: 2023-01-01T00:00:00.000000-05:00
          format: date-time
          type: string
        work_country:
          description: Work Country
          example: PE
          type: string
  securitySchemes:
    OAuth2:
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://accounts.salesloft.com/oauth/token
      type: oauth2
