List team endpoints

Snapshot: 0.9.17-patch1 · selected operations. This is a stored schema reference, not a fresh export or confirmation of behavior in another release. Scope and availability.

Availability and authentication

API access must be enabled for your deployment. Ask the platform administrator to confirm availability and the required API-key scope documented in the operation description below. Send the team API key in the X-API-Key header. Enabled interaction modes depend on endpoint runtime capabilities; the export profile does not enable them in your deployment.

GET /api/v1/endpoints

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

Parameters

Name	Location	Required	Description	Schema
page	query	No	Page number (1-based)	{"type":"string","pattern":"^[1-9][0-9]*$","default":"1"}
limit	query	No	Items per page (max 100)	{"type":"string","pattern":"^[1-9][0-9]*$","default":"20"}

Responses

These are declared schema responses, not results of live requests. An example is illustrative, not a complete catalogue of possible errors.

Status	Description
200	Default Response
400	Request validation failed
401	API key is missing or invalid
403	API key lacks the required scope or resource access
429	Too many requests
500	Unexpected server error

200

Default Response

Content type: application/json.

Required means required within its containing object. Exact schema below retains all constraints and alternatives.

Field	Type	Required	Description	Constraints
endpoints	array	Yes	Not described in snapshot.	—
endpoints[].id	string	Yes	Endpoint id to use with runtime/session APIs.	format: "uuid"
endpoints[].name	string	Yes	Endpoint display name.	—
pagination	object	Yes	Not described in snapshot.	—
pagination.total	number	Yes	Total matching items.	—
pagination.page	number	Yes	Current 1-based page number.	—
pagination.limit	number	Yes	Items requested per page.	—
pagination.totalPages	number	Yes	Total pages available.	—

Exact response schema and examples

{
  "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

Request validation failed

Exact response schema and examples

{
  "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

API key is missing or invalid

Exact response schema and examples

{
  "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

API key lacks the required scope or resource access

Exact response schema and examples

{
  "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

Too many requests

Exact response schema and examples

{
  "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

Unexpected server error

Exact response schema and examples

{
  "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"
        }
      }
    }
  }
}

Machine-readable reference

Download the selected OpenAPI operations. The download contains this subset only.