Back to PipedriveGet all products
Returns data about all products.
Input
type: object
properties:
parameters:
type: object
properties:
user_id:
type: integer
description: If supplied, only products owned by the given user will be returned
filter_id:
type: integer
description: The ID of the filter to use
ids:
type: array
items:
type: integer
description: >-
An array of integers with the IDs of the products that should be
returned in the response
first_char:
type: string
description: >-
If supplied, only products whose name starts with the specified letter
will be returned (case insensitive)
get_summary:
type: boolean
description: >-
If supplied, the response will return the total numbers of products in
the `additional_data.summary.total_count` property
start:
type: integer
default: 0
description: Pagination start
limit:
type: integer
description: Items shown per page
Output
title: getProductsResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: array
description: Array containing data for all products
items:
title: getproductResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: object
properties:
id:
type: number
description: The ID of the product
name:
type: string
description: The name of the product
code:
type: string
description: The product code
unit:
type: string
description: The unit in which this product is sold
tax:
type: number
description: The ax percentage
default: 0
active_flag:
description: Whether this product is active or not
title: numberBooleanDefault1
type: number
default: 1
enum:
- 0
- 1
selectable:
description: Whether this product is selected in deals or not
title: numberBooleanDefault1
type: number
default: 1
enum:
- 0
- 1
visible_to:
description: Visibility of the product
type: string
enum:
- '1'
- '3'
- '5'
- '7'
owner_id:
type: object
description: Information about the Pipedrive user who owns the product
prices:
type: array
description: >-
Array of objects, each containing: currency (string), price
(number), cost (number, optional), overhead_cost (number,
optional)
items:
type: object
related_objects:
type: object
properties:
user:
type: object
properties:
USER_ID:
type: object
title: userDataWithId
description: The ID of the user
properties:
id:
type: integer
description: The ID of the user
name:
type: string
description: The name of the user
email:
type: string
description: The email of the user
has_pic:
type: integer
description: >-
Whether the user has picture or not. 0 = No picture, 1 =
Has picture.
pic_hash:
type: string
nullable: true
description: The user picture hash
active_flag:
type: boolean
description: Whether the user is active or not
deal:
type: object
properties:
DEAL_ID:
type: object
description: The ID of the deal which is associated with the item
properties:
id:
type: integer
description: The ID of the deal associated with the item
title:
type: string
description: The title of the deal associated with the item
status:
type: string
description: The status of the deal associated with the item
value:
type: number
description: The value of the deal that is associated with the item
currency:
type: string
description: The currency of the deal value
stage_id:
type: integer
description: The ID of the stage the deal is currently at
pipeline_id:
type: integer
description: The ID of the pipeline the deal is in
person:
type: object
properties:
PERSON_ID:
type: object
description: The ID of the person associated with the item
properties:
id:
type: integer
description: The ID of the person associated with the item
name:
type: string
description: The name of the person associated with the item
email:
type: array
description: The emails of the person associated with the item
items:
type: object
properties:
label:
type: string
description: The type of the email
value:
type: string
description: The email of the associated person
primary:
type: boolean
description: Whether this is the primary email or not
phone:
type: array
description: The phone numbers of the person associated with the item
items:
type: object
properties:
label:
type: string
description: The type of the phone number
value:
type: string
description: >-
The phone number of the person associated with the
item
primary:
type: boolean
description: Whether this is the primary phone number or not
owner_id:
type: integer
description: >-
The ID of the owner of the person that is associated
with the item
organization:
type: object
properties:
ORGANIZATION_ID:
type: object
description: The ID of the organization associated with the item
properties:
id:
type: integer
description: The ID of the organization associated with the item
name:
type: string
description: The name of the organization associated with the item
people_count:
type: integer
description: >-
The number of people connected with the organization
that is associated with the item
owner_id:
type: integer
description: >-
The ID of the owner of the organization that is
associated with the item
address:
type: string
description: The address of the organization
cc_email:
type: string
description: >-
The BCC email of the organization associated with the
item
additional_data:
description: The additional data of the list
type: object
properties:
start:
type: integer
description: Pagination start
limit:
type: integer
description: Items shown per page
more_items_in_collection:
type: boolean
description: If there are more list items in the collection than displayed or not
related_objects:
type: object
properties:
user:
type: object
properties:
USER_ID:
type: object
title: userDataWithId
description: The ID of the user
properties:
id:
type: integer
description: The ID of the user
name:
type: string
description: The name of the user
email:
type: string
description: The email of the user
has_pic:
type: integer
description: >-
Whether the user has picture or not. 0 = No picture, 1 = Has
picture.
pic_hash:
type: string
nullable: true
description: The user picture hash
active_flag:
type: boolean
description: Whether the user is active or not
deal:
type: object
properties:
DEAL_ID:
type: object
description: The ID of the deal which is associated with the item
properties:
id:
type: integer
description: The ID of the deal associated with the item
title:
type: string
description: The title of the deal associated with the item
status:
type: string
description: The status of the deal associated with the item
value:
type: number
description: The value of the deal that is associated with the item
currency:
type: string
description: The currency of the deal value
stage_id:
type: integer
description: The ID of the stage the deal is currently at
pipeline_id:
type: integer
description: The ID of the pipeline the deal is in
person:
type: object
properties:
PERSON_ID:
type: object
description: The ID of the person associated with the item
properties:
id:
type: integer
description: The ID of the person associated with the item
name:
type: string
description: The name of the person associated with the item
email:
type: array
description: The emails of the person associated with the item
items:
type: object
properties:
label:
type: string
description: The type of the email
value:
type: string
description: The email of the associated person
primary:
type: boolean
description: Whether this is the primary email or not
phone:
type: array
description: The phone numbers of the person associated with the item
items:
type: object
properties:
label:
type: string
description: The type of the phone number
value:
type: string
description: The phone number of the person associated with the item
primary:
type: boolean
description: Whether this is the primary phone number or not
owner_id:
type: integer
description: >-
The ID of the owner of the person that is associated with the
item
organization:
type: object
properties:
ORGANIZATION_ID:
type: object
description: The ID of the organization associated with the item
properties:
id:
type: integer
description: The ID of the organization associated with the item
name:
type: string
description: The name of the organization associated with the item
people_count:
type: integer
description: >-
The number of people connected with the organization that is
associated with the item
owner_id:
type: integer
description: >-
The ID of the owner of the organization that is associated
with the item
address:
type: string
description: The address of the organization
cc_email:
type: string
description: The BCC email of the organization associated with the item