---
title: "List App route candidates"
method: GET
path: "/api/v1/apps/{appId}/route-candidates"
tags: ["Apps & Publishing"]
---

# List App route candidates

`GET /api/v1/apps/{appId}/route-candidates`

## Request

- Base URL: `https://app.promptingco.com`
- URL: `https://app.promptingco.com/api/v1/apps/{appId}/route-candidates`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - API key in cookie `better-auth.session_token`

## Path parameters

- `appId` string, required

## Query parameters

- `productId` string
- `status` 'draft' | 'published'
- `includeRouted` boolean

## Response `200`

Successful response

- object
  - `ok` true, required
  - `data` object, required
    - `appId` string, required
    - `candidateCount` integer, required
    - `candidates` object[], required
      - `targetType` 'product_document', required
      - `targetId` string, required
      - `suggestedPath` string, required
      - `pathStatus` 'already_routed' | 'path_conflict' | 'available', required
      - `existingRoute` object, nullable, required
        - `id` string, required
        - `path` string, required
      - `pathConflict` object, nullable, required
        - `id` string, required
        - `path` string, required
        - `targetType` string, required
        - `targetId` string, required
      - `target` object, required
        - `id` string, required
        - `title` string, required
        - `filePath` string, required
        - `sourceUrl` string, required
        - `status` string, required
        - `type` string, required
        - `redirectToUrl` string, nullable, required
        - `productId` string, required
      - `product` object, required
        - `id` string, required
        - `name` string, required
        - `slug` string, nullable, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `404`: Not found
- `422`: Validation failed
- `500`: Internal server error

---

[API](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api.md) - [All operations](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api/llms.txt) - [OpenAPI document](https://skmtc.dev/promptingcompany/apis/the-prompting-company-api/revisions/c0451ea10e9a?raw)