Back to Teamwork CRMList all products
Input
type: object
properties:
parameters:
type: object
properties:
orderMode:
type: string
default: asc
enum:
- asc
- desc
description: Which direction to order the results in.
orderBy:
type: string
description: >-
The sorting which the items are returned with, see the endpoints
documentation
for supported values and [sorting](/crm/general/sorting)
for more detailed documentation of how this works.
include:
type: string
description: |-
Comma separated list of relationships to include in the response.
See
[including related entities](/crm/general/related-entities)
for more detailed documentation of how this works.
pageSize:
maximum: 200
minimum: 1
type: integer
default: 20
description: >-
Max number of items per page
See [pagination](/crm/general/pagination) for more detailed
documentation of how this works.
pageOffset:
type: integer
default: 0
description: >-
Offset items in the page by amount. For example with a pageSize of 20
setting pageOffset to 20 will return the next page.
See [pagination](/crm/general/pagination) for more detailed
documentation of how this works.
title: Parameters
Output
type: object
title: productsResponse
properties:
included:
type: object
title: Included
meta:
type: object
title: ResponseMeta
properties:
page:
type: object
title: Page
properties:
count:
type: integer
pageOffset:
type: integer
pageSize:
type: integer
products:
type: array
items:
type: object
title: Product
properties:
avatar:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
createdAt:
type: string
description: When the item was created, as a datetime
format: date-time
createdBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
deletedAt:
type: string
description: When the item was deleted, as a datetime
format: date-time
deletedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
id:
type: integer
name:
type: string
owner:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
prices:
type: array
description: >-
Prices related to the product.
[Resource objects/entity
models](/crm/general/entity-models#relationships) for more details
on relationships.
items:
type: object
properties:
id:
type: integer
meta:
type: object
properties:
price:
type: integer
description: >-
Price of the product in the same currency as the deal in
its lowest denomination, e.g for USD the value in cents.
type:
type: string
enum:
- currencies
state:
type: string
description: State of the product.
enum:
- active
- inactive
updatedAt:
type: string
description: When the item was last updated, as a datetime
format: date-time
updatedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
updatedSourceId:
type: integer
description: Source ID of the latest request made (API / Web app)