Skip to main content
GET
/
api
/
projects
/
{id}
/
opportunities
List AI-generated opportunities for a project
curl --request GET \
  --url https://app.auditynow.com/api/projects/{id}/opportunities \
  --header 'Authorization: Bearer <token>'
{
  "opportunities": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "category": "quick_wins",
      "description": "<string>",
      "impactScore": 5,
      "effortScore": 5,
      "roiPotential": "<string>",
      "implementationTimeline": "<string>",
      "parallelExecution": true,
      "resourceRequirements": "<string>",
      "implementationStrategy": "<string>",
      "dependencies": [
        "<string>"
      ],
      "riskMitigation": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Path Parameters

​
id
string<uuid>
required

The project's UUID.

Query Parameters

​
category
enum<string>

Filter by opportunity category.

Available options:
quick_wins,
big_swings,
nice_to_haves,
deprioritize

Response

Opportunities

​
opportunities
object[]
required