Teamwork CRM API

Getting access, Developing, Testing

Back to Teamwork CRM

Search for filters

Search for filters given the text, search returns filters for user and custom filters.

The following values are allowed in the include query parameter:

  • users
  • custom-filters

Input

type: object properties: parameters: type: object properties: t: type: string description: The search term. 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: searchableResponse 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 searchResults: type: array items: type: object title: SearchableEntity properties: content: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". kind: type: string description: >- Kind is the `content` type, but a **deals** entity `type` can be of `kind` *"leads"* / *"opportunities"* and **pipelines** entity `type` can be of `kind` *"lead-pipelines"* / *"opportunity-pipelines"*. enum: - activities - companies - contacts - files - leads - leads-pipeline - notes - opportunities - |- opportunities-pipeline products - stages - users title: type: string description: Title is a string that represents the `content` entity.