FRfrain-dev
Portal Links

List all portal links

Changed on

This endpoint fetches multiple portal links

get/v1/projects/{projectID}/portal-links

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

Query parameters

direction'next' | 'prev'
next_page_cursorstring

A pagination cursor to fetch the next page of a list

ownerIdstring

The owner ID of the endpoint

perPageinteger

The number of items to return per page

prev_page_cursorstring

A pagination cursor to fetch the previous page of a list

qstring

The name of the endpoint

sortstring

Sort order, values are ASC or DESC, defaults to DESC

Response

OK

messagestring
statusboolean

Changes

  • 2ddfad646792Revision changes
    • warning

      deleted the query request parameter endpointID

    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • warning

      deleted the query request parameter sort

    • info

      api operation id LoadPortalLinksPaged was added

    • info

      added the new optional query request parameter ownerId

    • info

      added the new optional query request parameter q

  • 3600c8330869Revision changes
    • warning

      deleted the query request parameter sort

    • info

      added the new optional query request parameter sort