Skip to main content
GET
Get a partnership deal

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

partnershipId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
dealId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
created_at
string
required
updated_at
string
required
deal_value
number
required
total_commission_occurrences
number
required
lead_id
string
required
total_commission_value
number | null
required
stage_id
string | null
required
label
string
required
created_by_user_id
string | null
required
expiration_date
string | null
required
expired_at
string | null
required
currency_code
string | null
required
stage
object | null
required
created_by_user_first_name
string · null · null
required
created_by_user_last_name
string · null · null
required
created_by_user_email
string | null
required
created_by_user_profile_image_id
number | null
required
created_by_user_profile_image_uuid
string | null
required
lead_company_name
string | null
required
lead_first_name
string | null
required
lead_last_name
string | null
required
lead_email
string | null
required
lead_phone_number
string | null
required
lead_direction
enum<string> | null
required
Available options:
sent,
received
lead_status
enum<string>
required
Available options:
new,
converted,
rejected
lead_campaign_id
string | null
required
campaign_title
string · null · null
required
partnership
object | null
required
tags
object[]
required
assigned_users
object[]
required
assigned_contacts
object[]
required
custom_fields
object[]
required
has_quote
boolean
required
has_products
boolean
required
has_live_calculators
boolean
required
id
string
required
entry_commission_values
object[]
spiff_entry_commission_values
object[]
total_spiff_value
integer
Required range: -9007199254740991 <= x <= 9007199254740991
commission_overrides
object[]