Oppertunity

List Detailed Opportunities Endpoint `GET` /v1/api/opportunity/detailed/opportunities

Resource URL	/v1/api/opportunity/detailed/opportunities
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Retrieves a paginated list of detailed opportunities with optional filtering and sorting.

Parameters

Parameter	Description	Required	Type	Default Value
page_no	Page number (zero-based)	No	Integer	0
page_size	Number of items per page	No	Integer	10
sort_field	Field to sort by	No	String or null	N/A
sort_order	Sort order (e.g., asc, desc)	No	String or null	N/A
opportunity_name	Name of the opportunity	No	String or null	N/A
assignee	Assigned user	No	String or null	N/A
created_from	Start of creation date range	No	DateTime or null	N/A
created_to	End of creation date range	No	DateTime or null	N/A
score_min	Minimum score filter	No	Number or null	N/A
score_max	Maximum score filter	No	Number or null	N/A
type	Opportunity type	No	String or null	N/A
compliance_status	Compliance status filter	No	String or null	N/A
synopsis	Synopsis filter	No	String or null	N/A
summary	Summary filter	No	String or null	N/A
due_date_from	Start of due date range	No	Date or null	N/A
due_date_to	End of due date range	No	Date or null	N/A

Request Body

Parameter	Description	Required	Type	Default Value
status	Array of status values to filter by	No	Array[String] or null	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/opportunity/detailed/opportunities?page_no=0&page_size=10&sort_field=created&sort_order=desc&opportunity_name=ProjectX&created_from=2025-01-01T00:00:00&created_to=2025-04-07T23:59:59' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"status": ["active", "pending"]}'

Example Response

{
    "is_error": false,
    "message": "Opportunities retrieved successfully",
    "results": {}
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Get Opportunity Endpoint `GET` /v1/api/opportunity/detailed/{opportunity_id}

Resource URL	/v1/api/opportunity/detailed/{opportunity_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Retrieves detailed information about a specific opportunity identified by its opportunity ID.

Parameters

Parameter	Description	Required	Type	Default Value
opportunity_id	Unique identifier for the opportunity	Yes	String	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/opportunity/detailed/opp_456' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "is_error": false,
    "message": "Opportunity retrieved successfully",
    "results": {}
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Oppertunity

List Detailed Opportunities Endpoint GET /v1/api/opportunity/detailed/opportunities

HTTP Responses

Get Opportunity Endpoint GET /v1/api/opportunity/detailed/{opportunity_id}

HTTP Responses

On this page

List Detailed Opportunities Endpoint `GET` /v1/api/opportunity/detailed/opportunities

Get Opportunity Endpoint `GET` /v1/api/opportunity/detailed/{opportunity_id}