> ## Documentation Index
> Fetch the complete documentation index at: https://doc.rapida.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All Endpoints

Retrieves a paginated list of all endpoints with optional filtering criteria using the Rapida API.

<Info>
  For more authentication options, see: [https://doc.rapida.ai/api-reference/authentication](https://doc.rapida.ai/api-reference/authentication)
</Info>

## Parameters

<ParamField body="connectionConfig" type="ConnectionConfig" required>
  Configuration for the client connection.
</ParamField>

<ParamField body="request" type="GetAllEndpointRequest" required>
  <Expandable>
    <ParamField body="paginate" type="Paginate" required>
      Pagination configuration for the request.

      <Expandable>
        <ParamField body="page" type="uint32" required>
          The page number to retrieve (0-based indexing).
        </ParamField>

        <ParamField body="pageSize" type="uint32" required>
          Number of endpoints to return per page.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="criterias" type="Criteria[]" optional>
      Optional array of filtering criteria to apply to the endpoint search.

      <Expandable>
        <ParamField body="key" type="string" required>
          The field name to filter by.
        </ParamField>

        <ParamField body="value" type="string" required>
          The value to match against the specified key.
        </ParamField>

        <ParamField body="logic" type="string" required>
          The logic operator for the criteria. Accepted values: "should" | "must"
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

## Usage

<CodeGroup>
  ```python Python theme={null}
  from rapida import (
      ConnectionConfig,
      GetAllEndpointRequest,
      get_all_endpoint
  )
  from pprint import pprint
  connection_config = ConnectionConfig.default_connection_config(
      ConnectionConfig.with_sdk("{your-rapida-api-key}")
  )
  response = get_all_endpoint(
      client_cfg=connection_config,
      request=GetAllEndpointRequest(
          paginate=Paginate(page=0, pageSize=20),
          criterias=[Criteria(key="KEY", value="VALUE", logic="should")],
      ),
  )
  pprint(response)
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"os"

  	clients "github.com/rapidaai/rapida-go/rapida/clients"
  	rapida_proto "github.com/rapidaai/rapida-go/rapida/clients/protos"
  	connections "github.com/rapidaai/rapida-go/rapida/connections"
  )

  func main() {
  	// Configure client connection using RAPIDA_PROJECT_CREDENTIAL environment variable
  	connectionConfig := connections.
  		DefaultconnectionConfig(connections.WithSDK(os.Getenv("RAPIDA_PROJECT_CREDENTIAL"))).WithLocal()

  	// Retrieve all endpoints with pagination
  	response, err := clients.GetAllEndpoint(context.Background(), connectionConfig, &rapida_proto.GetAllEndpointRequest{
  		Paginate: &rapida_proto.Paginate{
  			Page:     0,
  			PageSize: 20,
  		},
  		// Optional: Add filtering criteria
  		// Criterias: []*rapida_proto.Criteria{{
  		// 	Key:   "key",
  		// 	Value: "value",
  		// 	Logic: "should", // or "must"
  		// }},
  	})

  	if err != nil {
  		fmt.Printf("Error while making call using rapida: %+v\n", err)
  		return
  	}

  	// Print the response
  	fmt.Printf("Rapida calling response: %+v\n", response)
  }
  ```

  ```typescript NodeJs theme={null}
  import {
    ConnectionConfig,
    GetAllEndpoints,
    Paginate,
    Criteria,
    GetAllEndpointRequest,
  } from "@rapidaai/nodejs";

  (async () => {
    const connectionCfg = ConnectionConfig.DefaultConnectionConfig(
      ConnectionConfig.WithSDK({
        ApiKey: process.env.RAPIDA_PROJECT_CREDENTIAL,
      })
    );
    getAllEndpoints(connectionCfg)
  })();

  async function getAllEndpoints(connectionCfg) {
    const request = new GetAllEndpointRequest();

    let paginate = new Paginate();
    paginate.setPage(0);
    paginate.setPagesize(20);
    request.setPaginate(paginate);

    let criteria = new Criteria();
    criteria.setKey("KEY FOR FILTER");
    criteria.setValue("MATCHING _VAULE");
    criteria.setLogic("should" || "must");
    request.addCriterias(criteria);
    const response = await GetAllEndpoints(connectionCfg, request);
    if (response.getError()) {
      console.error(
        "Error fetching all endpoints:",
        response.getError()?.getHumanmessage()
      );
    } else {
      console.log("All Endpoints:", response.getData().toObject());
    }
  }
  ```
</CodeGroup>

## Response

<ParamField body="code" type="int32">
  Numeric status code for the operation.
</ParamField>

<ParamField body="success" type="boolean">
  Indicates whether the operation was successful.
</ParamField>

<ParamField body="data" type="Endpoint[]">
  Array of endpoint objects returned by the request.

  <Expandable>
    <ParamField body="id" type="uint64">
      Unique identifier for the endpoint.
    </ParamField>

    <ParamField body="status" type="string">
      Operational status of the endpoint.
    </ParamField>

    <ParamField body="visibility" type="string">
      Visibility status of the endpoint.
    </ParamField>

    <ParamField body="source" type="string">
      Source of the endpoint.
    </ParamField>

    <ParamField body="sourceIdentifier" type="uint64">
      Identifier mapping to the endpoint's source.
    </ParamField>

    <ParamField body="projectId" type="uint64">
      Associated project identifier.
    </ParamField>

    <ParamField body="organizationId" type="uint64">
      Associated organization identifier.
    </ParamField>

    <ParamField body="endpointProviderModelId" type="uint64">
      Model identifier tied to the endpoint provider.
    </ParamField>

    <ParamField body="language" type="string">
      Selected language configuration for the endpoint.
    </ParamField>

    <ParamField body="name" type="string">
      Name assigned to the endpoint.
    </ParamField>

    <ParamField body="description" type="string">
      Description of the endpoint's purpose.
    </ParamField>

    <ParamField body="createdDate" type="timestamp">
      Timestamp of endpoint creation.
    </ParamField>

    <ParamField body="updatedDate" type="timestamp">
      Timestamp of last endpoint update.
    </ParamField>

    <ParamField body="createdBy" type="uint64">
      Identifier of the creator.
    </ParamField>

    <ParamField body="updatedBy" type="uint64">
      Identifier of the last updater.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="error" type="object">
  Error information, if applicable.

  <Expandable>
    <ResponseField name="errorCode" type="string">
      Machine-readable error code.
    </ResponseField>

    <ResponseField name="errorMessage" type="string">
      Detailed error message.
    </ResponseField>
  </Expandable>
</ParamField>

<ParamField body="paginated" type="object">
  Pagination information for the response.

  <Expandable>
    <ParamField body="totalCount" type="int64">
      Total number of endpoints available.
    </ParamField>

    <ParamField body="totalPages" type="int32">
      Total number of pages available.
    </ParamField>

    <ParamField body="currentPage" type="int32">
      Current page number (0-based).
    </ParamField>

    <ParamField body="pageSize" type="int32">
      Number of items per page.
    </ParamField>

    <ParamField body="hasNext" type="boolean">
      Indicates if there are more pages available.
    </ParamField>

    <ParamField body="hasPrevious" type="boolean">
      Indicates if there are previous pages available.
    </ParamField>
  </Expandable>
</ParamField>