Skip to content
em sa em sa

Get IP deal terms

GET
/api/canvas/{deal_id}/ip/terms
 
curl --request GET \
  --url https://example.com/api/canvas/example/ip/terms \
  --header 'Authorization: Bearer <token>'

Get current IP deal terms and auto-populated suggestions.

Returns saved terms (if any) plus auto-populated values from pipeline data. Frontend merges these: saved terms take priority, auto-populated fills gaps.

Phase 4: RequireViewer — all collaborators can view IP terms.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
IPTermsResponse

Response for IP deal terms retrieval.

object
terms
Any of:
object
key
additional properties
any
auto_populated
Any of:
object
key
additional properties
any
has_saved_terms
Has Saved Terms
boolean
pipeline_available
Pipeline Available
boolean
field_relevance
Any of:
object
key
additional properties
any
staleness
Any of:
object
key
additional properties
any
Example 
{
  "has_saved_terms": false,
  "pipeline_available": false
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}