---
title: "List all portal links"
method: GET
path: "/v1/projects/{projectID}/portal-links"
tags: ["Portal Links"]
---

# List all portal links

`GET /v1/projects/{projectID}/portal-links`

This endpoint fetches multiple portal links

## Path parameters

- `projectID` string, required

## Query parameters

- `direction` 'next' | 'prev'
- `next_page_cursor` string
- `ownerId` string
- `perPage` integer
- `prev_page_cursor` string
- `q` string
- `sort` string

## Response `200`

OK

- object
  - `message` string
  - `status` boolean
  - `data` object
    - `content` DatastorePortalLinkResponse[]
      - `auth_key` string
      - `auth_type` 'refresh_token' | 'static_token' | ''
      - `can_manage_endpoint` boolean
      - `created_at` string
      - `deleted_at` string, nullable
      - `endpoint_count` integer
      - `endpoints` string[]
      - `endpoints_metadata` DatastoreEndpoint[]
        - `advanced_signatures` boolean
        - `authentication` DatastoreEndpointAuthentication
          - `api_key` DatastoreApiKey
            - `header_name` string
            - `header_value` string
          - `basic_auth` DatastoreBasicAuth
            - `password` string
            - `username` string
          - `oauth2` DatastoreOAuth2
            - `audience` string
            - `authentication_type` 'shared_secret' | 'client_assertion' | ''
            - `client_id` string
            - `client_secret` string — Encrypted at rest
            - `expiry_time_unit` 'seconds' | 'milliseconds' | 'minutes' | 'hours' | ''
            - `field_mapping` DatastoreOAuth2FieldMapping
              - …
            - `grant_type` string
            - `issuer` string
            - `scope` string
            - `signing_algorithm` string
            - `signing_key` DatastoreOAuth2SigningKey
              - …
            - `subject` string
            - `url` string
          - `type` 'api_key' | 'oauth2' | 'basic_auth' | ''
        - `cb_state` string, nullable — CBState is the circuit breaker state ("open", "half-open", "closed") so the UI can reflect a tripped breaker on the endpoint status. Nil when CB is off/unlicensed or has no sample for this endpoint.
        - `content_type` string
        - `created_at` string
        - `deleted_at` string, nullable
        - `description` string
        - `events` integer
        - `failure_count` integer, nullable
        - `failure_rate` number, nullable — FailureRate is the circuit breaker's rolling failure rate for this endpoint. It is a pointer so the API can return null when no rate was computed (circuit breaker feature off, or sampler not running), distinct from a genuine 0%.
        - `http_timeout` integer
        - `mtls_client_cert` DatastoreMtlsClientCert
          - `client_cert` string — ClientCert is the client certificate PEM string
          - `client_key` string — ClientKey is the client private key PEM string
        - `name` string
        - `owner_id` string
        - `period_failure_rate` number, nullable — PeriodFailureRate is the period failure rate from event_deliveries, (Failure+Retry)/(Success+Failure+Retry). Retry counts as failed-so-far. Nil when the range has no counted deliveries; sibling counts are transient.
        - `project_id` string
        - `rate_limit` integer
        - `rate_limit_duration` integer
        - `retry_count` integer, nullable
        - `secrets` DatastoreSecret[]
          - `created_at` string
          - `deleted_at` string, nullable
          - `expires_at` string, nullable
          - `uid` string
          - `updated_at` string
          - `value` string
        - `slack_webhook_url` string
        - `status` 'active' | 'inactive' | 'paused' | ''
        - `success_count` integer, nullable
        - `support_email` string
        - `uid` string
        - `updated_at` string
        - `url` string
      - `name` string
      - `owner_id` string
      - `project_id` string
      - `token` string
      - `uid` string
      - `updated_at` string
      - `url` string
    - `pagination` DatastorePaginationData
      - `has_next_page` boolean
      - `has_prev_page` boolean
      - `next_page_cursor` string
      - `per_page` integer
      - `prev_page_cursor` string
      - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/frain-dev/apis/convoy-api-reference.md) · [All operations](https://skmtc.net/frain-dev/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frain-dev/convoy-api-reference/versions/dbd5b4f9cf13/schema)