Teamwork CRM API

Getting access, Developing, Testing

Back to Teamwork CRM

Export deals data show in the deals list view

Make sure you first read how to work with leads, opportunities, and deals.

The following targets are allowed in filter query parameters:

  • activitiesCount
  • closedAt
  • companyAddress
  • companyContactId
  • companyCount
  • companyCountryId
  • companyEmail
  • companyId
  • companyName
  • companyPhone
  • companyState
  • companyTimezoneId
  • companyTimezoneName
  • companyUpdatedAt
  • completeActivitiesCount
  • contactId
  • contactsCount
  • createdAt
  • createdByUserId
  • currencyId
  • dealId
  • expectedCloseDate
  • id
  • incompleteActivitiesCount
  • isQualified
  • isRotting
  • lastActivityAssigneeId
  • lastActivityCompletedAt
  • lastActivityContactId
  • lastActivityCreatedAt
  • lastActivityCreatedByUserId
  • lastActivityDate
  • lastActivityTitle
  • lastActivityType
  • lostAt
  • lostReasonId
  • lostReasonName
  • mainContactCount
  • mainContactEmail
  • mainContactJobTitle
  • mainContactName
  • mainContactOwnerId
  • mainContactPhone
  • mainContactUpdatedAt
  • nextActivityAssigneeId
  • nextActivityContactId
  • nextActivityCreatedAt
  • nextActivityCreatedByUserId
  • nextActivityDate
  • nextActivityTitle
  • nextActivityType
  • ownerId
  • pipelineId
  • productId
  • projectId
  • qualifiedAt
  • stageId
  • state
  • stateId
  • taskId
  • title
  • totalValue
  • updatedAt
  • wonAt
  • wonReasonId
  • wonReasonName

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: Column to order by, e.g d1. ids: type: string description: Comma separated list of ids to find the position for. filterId: type: integer description: The id of the custom filter to apply. required: - ids title: Parameters

Output

type: object title: exportResponse properties: export: type: object title: Export properties: bytes: type: integer 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 downloadUrl: type: string expirationDate: type: string format: date-time filterName: type: string id: type: integer kind: type: string description: Kind of entity exported. enum: - leads - opportunities - companies - contacts - activities - products - users pipelineName: type: string state: type: integer 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) included: type: object title: Included