Retained reference snapshot. This independently versioned API snapshot does not select or advance a platform or SDK release.

GET /api/v1/endpoints

List team endpoints

Returns all endpoints belonging to the team associated with the API key. Requires a team API key with READ_TEAM_APPS scope.

Request, response and operation contract

{
  "summary": "List team endpoints",
  "tags": ["Endpoints"],
  "description": "Returns all endpoints belonging to the team associated with the API key. Requires a team API key with READ_TEAM_APPS scope.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$",
        "default": "1"
      },
      "example": "1",
      "in": "query",
      "name": "page",
      "required": false,
      "description": "Page number (1-based)"
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$",
        "default": "20"
      },
      "example": "20",
      "in": "query",
      "name": "limit",
      "required": false,
      "description": "Items per page (max 100)"
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": ["endpoints", "pagination"],
            "properties": {
              "endpoints": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": ["id", "name"],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Endpoint id to use with runtime/session APIs."
                    },
                    "name": {
                      "type": "string",
                      "description": "Endpoint display name."
                    }
                  }
                }
              },
              "pagination": {
                "type": "object",
                "required": ["total", "page", "limit", "totalPages"],
                "properties": {
                  "total": {
                    "type": "number",
                    "description": "Total matching items."
                  },
                  "page": {
                    "type": "number",
                    "description": "Current 1-based page number."
                  },
                  "limit": {
                    "type": "number",
                    "description": "Items requested per page."
                  },
                  "totalPages": {
                    "type": "number",
                    "description": "Total pages available."
                  }
                }
              }
            }
          },
          "example": {
            "endpoints": [
              {
                "id": "0f6c3d4e-8b8f-4c59-9d0e-7e5e3b1f7f0f",
                "name": "Website assistant"
              }
            ],
            "pagination": {
              "total": 1,
              "page": 1,
              "limit": 20,
              "totalPages": 1
            }
          }
        }
      }
    },
    "400": {
      "description": "Request validation failed",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "Request validation failed",
            "required": ["error"],
            "properties": {
              "error": {
                "type": "object",
                "required": ["code", "message"],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Stable machine-readable error code.",
                    "example": "VALIDATION_ERROR"
                  },
                  "message": {
                    "type": "string",
                    "description": "Human-readable error summary.",
                    "example": "Request validation failed"
                  },
                  "details": {
                    "description": "Optional structured details, usually validation issues."
                  },
                  "requestId": {
                    "type": "string",
                    "description": "Fastify request id for log correlation when available."
                  }
                }
              }
            }
          },
          "example": {
            "error": {
              "code": "VALIDATION_ERROR",
              "message": "Request validation failed"
            }
          }
        }
      }
    },
    "401": {
      "description": "API key is missing or invalid",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "API key is missing or invalid",
            "required": ["error"],
            "properties": {
              "error": {
                "type": "object",
                "required": ["code", "message"],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Stable machine-readable error code.",
                    "example": "VALIDATION_ERROR"
                  },
                  "message": {
                    "type": "string",
                    "description": "Human-readable error summary.",
                    "example": "Request validation failed"
                  },
                  "details": {
                    "description": "Optional structured details, usually validation issues."
                  },
                  "requestId": {
                    "type": "string",
                    "description": "Fastify request id for log correlation when available."
                  }
                }
              }
            }
          },
          "example": {
            "error": {
              "code": "AUTHENTICATION_ERROR",
              "message": "API key is missing or invalid"
            }
          }
        }
      }
    },
    "403": {
      "description": "API key lacks the required scope or resource access",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "API key lacks the required scope or resource access",
            "required": ["error"],
            "properties": {
              "error": {
                "type": "object",
                "required": ["code", "message"],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Stable machine-readable error code.",
                    "example": "VALIDATION_ERROR"
                  },
                  "message": {
                    "type": "string",
                    "description": "Human-readable error summary.",
                    "example": "Request validation failed"
                  },
                  "details": {
                    "description": "Optional structured details, usually validation issues."
                  },
                  "requestId": {
                    "type": "string",
                    "description": "Fastify request id for log correlation when available."
                  }
                }
              }
            }
          },
          "example": {
            "error": {
              "code": "AUTHORIZATION_ERROR",
              "message": "API key lacks the required scope or resource access"
            }
          }
        }
      }
    },
    "429": {
      "description": "Too many requests",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "Too many requests",
            "required": ["error"],
            "properties": {
              "error": {
                "type": "object",
                "required": ["code", "message"],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Stable machine-readable error code.",
                    "example": "VALIDATION_ERROR"
                  },
                  "message": {
                    "type": "string",
                    "description": "Human-readable error summary.",
                    "example": "Request validation failed"
                  },
                  "details": {
                    "description": "Optional structured details, usually validation issues."
                  },
                  "requestId": {
                    "type": "string",
                    "description": "Fastify request id for log correlation when available."
                  }
                }
              }
            }
          },
          "example": {
            "error": {
              "code": "RATE_LIMIT_EXCEEDED",
              "message": "Too many requests"
            }
          }
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "Unexpected server error",
            "required": ["error"],
            "properties": {
              "error": {
                "type": "object",
                "required": ["code", "message"],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "Stable machine-readable error code.",
                    "example": "VALIDATION_ERROR"
                  },
                  "message": {
                    "type": "string",
                    "description": "Human-readable error summary.",
                    "example": "Request validation failed"
                  },
                  "details": {
                    "description": "Optional structured details, usually validation issues."
                  },
                  "requestId": {
                    "type": "string",
                    "description": "Fastify request id for log correlation when available."
                  }
                }
              }
            }
          },
          "example": {
            "error": {
              "code": "INTERNAL_ERROR",
              "message": "Unexpected server error"
            }
          }
        }
      }
    }
  }
}

Shared path-item configuration

{}

Effective document defaults

{
  "servers": [],
  "security": []
}

Resolve local schema references in the component catalogue or the exact OpenAPI download. Operation and path-item overrides retain their OpenAPI meaning; omitted security is not a declaration that authentication is unnecessary.