Prior version of the Clozd public Data API. Get a paged list of deals for a program, get a single deal with details, and import deals with participants. Superseded by v3.0, which adds programs, competitors and touchpoints. Authenticated with the x-api-token header.
info:
contact:
email: support@clozd.com
description: Documentation on how to utilize the Clozd Data API.
license:
name: Public API v2.0
url: ''
termsOfService: https://www.clozd.com/privacy/terms-of-use
title: Clozd Data API
version: v2.0
openapi: 3.0.3
paths:
/programs/{program_id}/deals/{deal_id}:
get:
description: "Get a specific deal with details (basic fields, extra fields, (optionally) custom metadata fields, participants, products, published feedback responses, and full feedback transcript. Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app. \n - :deal_id is required, see /programs/:program_id/deals to get a paged list of program deals."
summary: Get deal with details
operationId: get-deal-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
description: Success response
type: object
properties:
success:
description: Success flag
type: boolean
message:
description: Success message
type: string
data:
description: Deal
type: object
properties:
clozd_deal_name:
description: The name of the deal
type: string
clozd_external_id:
description: Your id for this deal. This is not generated by Clozd. If you have existing deals with the same external id, they will be updated with the import
type: string
clozd_organization_domain:
description: 'Deal domain example: www.clozd.com'
type: string
clozd_organization_name:
description: Clozd organization name (max:250 chars)
type: string
clozd_deal_id:
description: Clozd generated deal id (min:36 chars, max:36 chars)
type: string
format: uuid
clozd_amount:
description: This reflects how much the deal was for
format: double
type: number
clozd_closed_date:
description: When the deal was closed (max:25 chars, ISO8601 date-time format)
format: date-time
type: string
clozd_created_date:
description: When the deal was created (max:25 chars, ISO8601 date-time format)
format: date-time
type: string
clozd_currency:
description: The type of currency used in this deal
type: string
clozd_headcount:
description: Head count for the deal
format: int64
type: integer
clozd_industry:
description: Industry from a picklist of values in the Clozd app
type: string
clozd_lead_source:
description: Lead source to the deal
type: string
clozd_outcome:
description: Reflects the outcome of the deal allowed values are 'win' or 'loss'
enum:
- win
- loss
type: string
clozd_outcome_type:
description: What type of deal was the outcome affecting
type: string
clozd_region:
description: Region for the deal, must be a value from the picklist in Clozd app
type: string
clozd_revenue:
description: This is the revenue for the deal
format: double
type: number
clozd_sales_rep_email:
description: The email for the sales rep for the deal
format: email
type: string
clozd_sales_rep_name:
description: The name of the sales rep for the deal
type: string
clozd_products:
description: 'An array of products, if there is only one product, an array of one ie: [''product'']'
type: array
items:
description: Parameter without description.
type: string
clozd_participants:
description: List of participants that belong to the deal (maxItems:1000)
maxItems: 1000
type: array
items:
$ref: '#/components/schemas/Participant'
clozd_share_link:
description: Read-only, absolute path for sharing (unauthenticated) deals with published feedback
type: string
clozd_insight_gems:
description: Insight gems (AWE flags) associated with the deal
type: array
items:
description: Insight gem element
type: object
properties:
type:
description: 'The type of insight gem (AWE flag): at_risk, win_back, or expansion'
enum:
- at_risk
- win_back
- expansion
type: string
created_by_type:
description: 'Provenance of the insight gem: ai (system-generated), clozd_consultant (created by a Clozd consultant), user (created by a customer user), or null when unclassifiable'
enum:
- ai
- clozd_consultant
- user
type: string
reason:
description: The reason the insight gem was applied to the deal
type: string
created_at:
description: When the insight gem was created (max:25 chars, ISO8601 date-time format)
format: date-time
type: string
notification_date:
description: When the assigned owners will be or were notified to act on the insight gem; null when no notification is scheduled (max:25 chars, ISO8601 date-time format)
format: date-time
type: string
clozd_responses:
description: List of deal feeback responses
type: array
items:
description: Deal feedback response from interview or survey
type: object
properties:
clozd_response_id:
description: Clozd generated feedback response identifier (min:36 chars, max:36 chars)
type: string
format: uuid
clozd_response_participant:
description: Parameter without description.
type: object
properties:
clozd_participant_id:
description: Clozd generated participant id (min:36 chars, max:36 chars)
type: string
format: uuid
clozd_participant_external_id:
description: Your id for this participant. This is not generated by Clozd. If you have existing participants with the same external id, they will be updated with the import
type: string
clozd_participant_first_name:
description: First name of participant
type: string
clozd_participant_last_name:
description: Last name of participant
type: string
clozd_participant_email:
description: The email for the participant of the deal
format: email
type: string
clozd_participant_type:
description: Specifying if the person is a buyer or a sales participant values are 'buyer' or 'sales'
enum:
- buyer
- sales
type: string
clozd_participant_is_primary:
description: Is the participant the primary participant for the deal
type: boolean
clozd_participant_phone:
description: Phone number for the pariticipant
type: string
clozd_participant_title:
description: Job title of the participant
type: string
clozd_participant_role:
description: The role the participant had in the deal
type: string
clozd_channel:
description: Feedback channel
enum:
- buyer interview
- buyer survey
- rep interview
- rep survey
type: string
clozd_decision:
description: Decision
enum:
- lost to competitor
- lost to no decision
- unknown
- won
type: string
clozd_primary_competitor:
description: Primary competitor
type: string
clozd_publish_date:
description: Date and time the feedback interview or survey was published (max:25 chars, ISO8601 date-time format)
format: date-time
type: string
clozd_summary:
description: Summary of feedback response
type: string
clozd_drivers:
description: List of decision drivers
type: array
items:
description: Key decision driver
type: object
properties:
clozd_driver_name:
description: Name of decision driver
type: string
clozd_driver_rating:
description: 'Decision driver rating (2: Strong Positive, 1: Positive, -1: Negative, -2: Strong Negative)'
enum:
- 2
- 1
- -1
- -2
format: int64
type: integer
clozd_driver_quotes:
description: List of quotes associated with this decision driver
type: array
items:
description: Buyer or rep quote associated with this decision driver
type: string
clozd_tags:
description: List of tags
type: array
items:
description: Tag information
type: object
properties:
tag_cateogry_id:
description: Category id for the tag
type: string
tag_category:
description: Category name for the tag
type: string
tag_id:
description: Id for the tag
type: string
tag_name:
description: Name of the tag
type: string
tag_type:
description: Will either be auto (smart tags) or manual
type: string
thread_id:
description: The thread id for the tag
type: string
quote:
description: The quote text of the response the tag was associated with
type: string
clozd_transcript:
description: List of interview sections in sequence
type: array
items:
description: Section of interview
type: object
properties:
clozd_section:
description: Section name
type: string
clozd_dialogue:
description: List of question and answer pairs in sequence
type: array
items:
description: Question and answer pair
type: object
properties:
clozd_question:
description: Interview question
type: string
clozd_answer:
description: Participant answer
type: string
example:
success: true
message: Successfully retrieved deal details
data:
clozd_deal_id: f9437462-7e03-4bcc-a4db-84fc0dba4d01
clozd_share_link: https://app.clozd.com/share/deals/f9437462-7e03-4bcc-a4db-84fc0dba4d01
clozd_external_id: '0000001'
clozd_organization_domain: acme.com
clozd_organization_name: ACME, Inc.
clozd_deal_name: ACME, Inc.
clozd_industry: SaaS
clozd_amount: 10000
clozd_currency: USD
clozd_outcome: loss
clozd_outcome_type: churn
clozd_closed_date: '2022-01-09T18:57:08.485Z'
clozd_created_date: '2022-03-09T18:57:08.485Z'
clozd_lead_source: SDR
clozd_segment: B2B
clozd_region: East
clozd_headcount: 12
clozd_revenue: 10000
clozd_sales_rep_name: Sales Rep
clozd_sales_rep_email: rep@sales.com
clozd_products:
- Flagship
clozd_participants:
- clozd_participant_id: 7624ba11-291a-450b-9781-dda5977321ba
clozd_participant_external_id: '0000002'
clozd_participant_first_name: First
clozd_participant_last_name: Last
clozd_participant_email: participant@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_insight_gems:
- type: expansion
created_by_type: user
reason: null
created_at: '2026-07-01T12:00:00.000Z'
notification_date: null
clozd_responses:
- clozd_response_id: d2c7ffae-2be7-4d4c-b081-2c6153c105f5
clozd_response_participant:
clozd_participant_id: 7624ba11-291a-450b-9781-dda5977321ba
clozd_participant_external_id: '0000002'
clozd_participant_first_name: First
clozd_participant_last_name: Last
clozd_participant_email: participant@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_channel: buyer interview
clozd_decision: lost to competitor
clozd_primary_competitor: BigCo, Inc.
clozd_publish_date: '2022-04-09T18:57:08.485Z'
clozd_summary: ACME chose BigCo over MyCo because they felt it offered totally comparable features for only one-third the cost. BigCo had the strongest sales experience and would have been the first choice, but was removed from consideration because the price was so much higher than competitors.
clozd_drivers:
- clozd_driver_name: Perceived Value Relative to Price
clozd_driver_rating: -1
clozd_driver_quotes:
- MyCo's pricing is just wildly higher than every [other vendor] I spoke to, with the exception of TheirCo. [HereCo] is maybe a third of what [MyCo] was quoting us . . . There was really just no way to justify that massive premium.
- clozd_driver_name: Trust & Professionalism
clozd_driver_rating: 1
clozd_driver_quotes:
- '[MyCo''s biggest strength] was that the people I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to. Every scenario I posed, they had handled before. [MyCo''s] website really gives you a good sense of security and that they know what they''re doing. I mean, everybody I dealt with over there was fantastic.'
clozed_tags:
- tag_cateogry_id: a9c27012-cef4-4655-8a8a-08a1dec87171
tag_category: User Interface
tag_id: 74bee386-4198-42ef-8af1-6334d303362a
tag_name: Critical UI Feedback
tag_type: manual
thread_id: c60de976-53e0-4232-bad4-e1ab87ba61e6
quote: not very user friendly.
- tag_cateogry_id: a9c27012-cef4-4655-8a8a-08a1dec87171
tag_category: Business Strategy
tag_id: 74bee386-4198-42ef-8af1-6334d303362a
tag_name: Business Direction
tag_type: manual
thread_id: 45601e8d-7367-4fe5-a533-08cf8b2395eb
quote: we did not want to go the direction of a PEO
- tag_cateogry_id: 923e9fbe-2830-45a7-8b0b-ae2f05cb28d7
tag_category: Feature Capability
tag_id: ab753b8c-ba60-4532-8e08-f414a9a7d64c
tag_name: Expertise
tag_type: manual
thread_id: 03ff92e1-af06-4a44-abab-b780107e8135
quote: ' their specialty is really that PEO side, which if we really needed it, that''s that would be the direction we would have gone in.'
clozd_transcript:
- clozd_section: Overview & Origination
clozd_dialogue:
- clozd_question: What was your company's final decision?
clozd_answer: We decided not to purchase MyCo.
- clozd_question: How did you first hear about MyCo?
clozd_answer: I'm pretty sure I just Googled for secure hosting providers, service providers, those sorts of terms.
- clozd_section: Product Offering
clozd_dialogue:
- clozd_question: Did MyCo's service justify any type of premium compared to other vendors?
clozd_answer: I definitely have confidence, just based on who I spoke to and all the stuff that they laid out that they do, but I wouldn't say that they're markedly better than their competitors.
- clozd_question: Did MyCo offer any outsourcing in terms of who manages your service?
clozd_answer: So, MyCo basically is the same exact thing except it's their own infrastructure. So, they're not using AWS. They have their own data centers and their own servers.
- clozd_section: Conclusion
clozd_dialogue:
- clozd_question: What is MyCo's biggest strength that makes them stand out against their competitors?
clozd_answer: Honestly, it was just the people that I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to, every scenario I posed, they had handled before.
- clozd_question: Is there anything else MyCo should know about your experience?
clozd_answer: No, I think that is all. I hope this was helpful.
'400':
description: Failed operation (Bad Request)
content:
application/json:
schema:
description: Bad Request response
type: object
properties:
success:
description: Success flag
type: boolean
message:
description: Error message
type: string
errorCode:
description: Error code
type: string
data:
description: Data
type: object
properties: {}
example:
success: false
message: Bad Request.
errorCode: API009
data: {}
'401':
description: Failed operation (Unauthorized)
content:
application/json:
schema:
description: Unauthorized response
type: object
properties:
success:
description: Success flag
type: boolean
message:
description: Error message
type: string
errorCode:
description: Error code
type: string
data:
description: Data
type: object
properties: {}
example:
success: false
message: Not authorized.
errorCode: AUTH005
data: {}
tags:
- /programs/:program_id/deals/:deal_id
parameters:
- description: 'Specifies type of data to include with deal. NOTE: Cannot include ''transcripts'' without also including ''feedback'' (maxItems:5)'
in: query
name: include[]
required: false
schema:
description: 'Specifies type of data to include with deal. NOTE: Cannot include ''transcripts'' without also including ''feedback'' (maxItems:5)'
default:
- customFields
- participants
- products
- feedback
maxItems: 5
nullable: true
type: array
items:
description: Parameter without description.
enum:
- customFields
- participants
- products
- feedback
- transcripts
type: string
example:
- customFields
- participants
- products
- description: Clozd program ID (min:36 chars, max:36 chars)
in: path
name: program_id
required: true
schema:
description: Clozd program ID (min:36 chars, max:36 chars)
minLength: 36
maxLength: 36
type: string
format: uuid
example: 760c040c-5dda-41e8-85ff-ef8f411d39d5
- description: Clozd deal ID (min:36 chars, max:36 chars)
in: path
name: deal_id
required: true
schema:
description: Clozd deal ID (min:36 chars, max:36 chars)
minLength: 36
maxLength: 36
type: string
format: uuid
example: f9437462-7e03-4bcc-a4db-84fc0dba4d01
/programs/{program_id}/deals:
get:
description: "Get a paged list of deals with basic fields and share link for deals with published feedback. See /programs/:program_id/deals/:deal_id endpoint to get a specific deal with details. Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app."
summary: Get list of Clozd program deals
operationId: get-deals-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
description: Success response
type: object
properties:
success:
description: Success flag
type: boolean
message:
description: Success message
type: string
links:
description: Absolute path links to paged results
type: object
properties:
self:
description: Current page of results
type: string
prev:
description: Previous page of results
type: string
next:
description: Next page of results
type: string
first:
description: First page of results
type: string
last:
description: Last page of results
type: string
count:
description: Number of deals in current page of results
format: int64
type: integer
total:
description: Number of total deals in all pages of results
format: int64
type: integer
data:
description: Parameter without description.
type: array
items:
description: Deal
type: object
properties:
clozd_deal_name:
description: The name of the deal
type: string
clozd_external_id:
description: Your id for this deal. This is not generated by Clozd. If you have existing deals with the same external id, they will be updated with the import
type: string
clozd_organization_domain:
description: 'Deal domain example: www.clozd.com'
type: string
clozd_organization_name:
description: Clozd organization name (max:250 chars)
type: string
clozd_deal_id:
description: Clozd generated deal id (min:36 chars, max:36 chars)
type: string
format: uuid
clozd_share_link:
description: Read-only, absolute path for sharing (unauthenticated) deals with published feedback
type: string
clozd_insight_gems:
description: Insight gems (AWE flags) associated with the deal
type: array
items:
description: Insight gem element
type: object
properties:
type:
description: 'The type of insight gem (AWE flag): at_risk, win_back, or expansion'
enum:
- at_risk
- win_back
- expansion
type: string
created_by_type:
description: 'Provenance of the insight gem: ai (system-generated), clozd_consultant (created by a Clozd consultant), user (created by a customer user), or null when unclassifiable'
enum:
- ai
- clozd_consultant
- user
type: string
reason:
description: The reason the insight gem was applied to the deal
type: string
created_at:
description: Wh
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clozd/refs/heads/main/openapi/clozd-data-api-v2-openapi.yml