Back to Teamwork CRMList all custom fields
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: customFieldsResponse
properties:
customFields:
type: array
items:
type: object
title: CustomField
properties:
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
fieldType:
type: string
description: Type of the of the custom field value.
enum:
- companies
- contacts
- date
- duration
- multi-select
- number
- select
- text-long
- text-short
- time
- url
- users
id:
type: integer
isMandatory:
type: boolean
description: >-
Mandatory is true if the custom field must have a value set, when
the entity to which the custom field is
assigned to, is created or updated.
isShownWhenAdding:
type: boolean
description: >-
Shown when adding is true when the custom field should be shown in
the entity's form.
key:
type: string
description: >-
Key is the custom field's identifier used in the entities responses
that include custom fields.
kind:
type: string
description: Kind of entity this custom field is defined for.
enum:
- deals
- contacts
- companies
name:
type: string
options:
type: array
description: >-
Options for the custom field with `fieldType` "select" or
"multi-select".
items:
type: string
orderIndex:
type: integer
description: >-
Position of the custom field in the set of all non deleted custom
fields.
Lower numbers come first when retrieving multiple elements at once.
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)
meta:
type: object
title: ResponseMeta
properties:
page:
type: object
title: Page
properties:
count:
type: integer
pageOffset:
type: integer
pageSize:
type: integer