> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackup.me/llms.txt
> Use this file to discover all available pages before exploring further.

# List project links

> Requires link.list. Lists project links with pagination and optional type/name filters. Links owned by a page are hidden unless includePageLinks=true.



## OpenAPI

````yaml https://api.trackup.me/openapi.json get /v1/projects/{id}/links
openapi: 3.1.0
info:
  title: Trackup API
  description: >-
    API-key-accessible Trackup operations. Send your key in the `X-Api-Key`
    header.


    Keys belong to a team. `X-Team-Id` is not required; if supplied, it must
    match that team.


    Each operation lists its required key permission. The key creator must
    remain a team member and normally hold that permission. The ingest-only
    permissions `visitor.create`, `conversion.create`, and `request.create` do
    not need to be held by the creator.


    Project access and selection are described per operation. Session-only
    account, administration and OAuth operations are not part of this reference.


    The same operations are available as MCP tools at `/mcp` (Streamable HTTP).
    Authenticate with `X-Api-Key` or connect through OAuth, which issues an API
    key on consent.


    Schema validation errors return HTTP 422 with an `errors` object. Other
    errors generally contain `error` and `message`; operation-specific responses
    describe exceptions.
  version: 1.0.0
servers:
  - url: /
    description: Current API environment
security:
  - ApiKey: []
paths:
  /v1/projects/{id}/links:
    get:
      tags:
        - Links
      summary: List project links
      description: >-
        Requires link.list. Lists project links with pagination and optional
        type/name filters. Links owned by a page are hidden unless
        includePageLinks=true.
      operationId: listLinks
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - in: query
          name: type
          schema:
            type: string
            enum:
              - generic
              - traffic_source
              - sales_platform
        - in: query
          name: name
          schema:
            type: string
            maxLength: 255
        - in: query
          name: includePageLinks
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: Project links and total count.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkList'
        '401':
          description: The X-Api-Key header is missing or the API key is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The key is expired, revoked, lacks permission, or its creator no
            longer has the required team access. A conflicting X-Team-Id is also
            rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            The requested resource was not found or is outside the permitted
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Invalid input. Each field path maps to its first validation message;
            _form identifies an object-level error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    LinkList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        count:
          type: number
      required:
        - data
        - count
      example:
        data:
          - id: 44444444-4444-4444-8444-444444444444
            projectId: 11111111-1111-4111-8111-111111111111
            name: Landing experiment
            pathname: /landing-test
            type: generic
            trafficSourceId: null
            salesPlatformId: null
            createdAt: '2026-10-26T12:00:00.000Z'
            updatedAt: '2026-10-26T12:30:00.000Z'
        count: 1
    ApiError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      additionalProperties: true
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: string
      required:
        - errors
    Link:
      type: object
      properties:
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
        name:
          type: string
        pathname:
          type: string
        type:
          type: string
          enum:
            - generic
            - traffic_source
            - sales_platform
        trafficSourceId:
          type:
            - string
            - 'null'
          format: uuid
        salesPlatformId:
          type:
            - string
            - 'null'
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - projectId
        - name
        - pathname
        - type
        - trafficSourceId
        - salesPlatformId
        - createdAt
        - updatedAt
      example:
        id: 44444444-4444-4444-8444-444444444444
        projectId: 11111111-1111-4111-8111-111111111111
        name: Landing experiment
        pathname: /landing-test
        type: generic
        trafficSourceId: null
        salesPlatformId: null
        createdAt: '2026-10-26T12:00:00.000Z'
        updatedAt: '2026-10-26T12:30:00.000Z'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.