Skip to content

get-endpoints-request.md

Latest commit

 

History

History
30 lines (25 loc) · 4.75 KB

get-endpoints-request.md

File metadata and controls

30 lines (25 loc) · 4.75 KB
Raw

GetEndpointsRequest

Example Usage

import { GetEndpointsRequest } from "convoy.js/models/operations";

let value: GetEndpointsRequest = {
  projectID: "<id>",
  nextPageCursor: "01H0JA5MEES38RRK3HTEJC647K",
  ownerId: "01H0JA5MEES38RRK3HTEJC647K",
  perPage: 20,
  prevPageCursor: "01H0JATTVCXZK8FRDX1M1JN3QY",
  q: "endpoint-1",
  sort: "ASC | DESC",
};

Fields

Field Type Required Description Example
projectID string ✔️ Project ID
direction operations.GetEndpointsDirection ➖ N/A
nextPageCursor string ➖ A pagination cursor to fetch the next page of a list 01H0JA5MEES38RRK3HTEJC647K
ownerId string ➖ The owner ID of the endpoint 01H0JA5MEES38RRK3HTEJC647K
perPage number ➖ The number of items to return per page 20
prevPageCursor string ➖ A pagination cursor to fetch the previous page of a list 01H0JATTVCXZK8FRDX1M1JN3QY
q string ➖ The name of the endpoint endpoint-1
sort string ➖ Sort order, values are ASC or DESC, defaults to DESC ASC | DESC