> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List API Endpoints

> List all API endpoints with optional filtering and pagination

# List API Endpoints

List all API endpoints with optional filtering and pagination.

## Query Parameters

<ParamField query="apiCollection" type="string">
  Filter by API collection fully qualified name.
</ParamField>

<ParamField query="service" type="string">
  Filter by API service fully qualified name.
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `owners`, `tags`, `extension`, `domains`, `sourceHash`. See [Supported Fields](#supported-fields) below.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/apiEndpoints theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import APIEndpoints

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # List first page
  endpoints = APIEndpoints.list(limit=50)
  for ep in endpoints.data:
      print(f"{ep.fullyQualifiedName}")

  # List all with auto-pagination
  for ep in APIEndpoints.list_all():
      print(f"{ep.fullyQualifiedName}")

  # Filter by API collection
  endpoints = APIEndpoints.list(
      apiCollection="sample_api_service.pet",
      fields=["owners", "tags", "domain"],
      limit=50
  )

  for ep in endpoints.data:
      print(f"{ep.fullyQualifiedName} [{ep.requestMethod}]")
      if ep.owners:
          print(f"  Owners: {[o.name for o in ep.owners]}")
      if ep.tags:
          print(f"  Tags: {[t.tagFQN for t in ep.tags]}")
  ```

  ```java GET /v1/apiEndpoints theme={null}
  import static org.openmetadata.sdk.fluent.APIEndpoints.*;

  // List first page
  var result = APIEndpoints.list()
      .limit(50)
      .execute();

  for (var ep : result.getData()) {
      System.out.println(ep.getFullyQualifiedName());
  }

  // Filter by API collection with fields
  var result = APIEndpoints.list()
      .apiCollection("sample_api_service.pet")
      .fields("owners", "tags", "domain")
      .limit(50)
      .execute();

  for (var ep : result.getData()) {
      System.out.println(ep.getFullyQualifiedName());
  }
  ```

  ```bash GET /v1/apiEndpoints theme={null}
  # List all
  curl "{base_url}/api/v1/apiEndpoints?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by API collection
  curl "{base_url}/api/v1/apiEndpoints?apiCollection=sample_api_service.pet&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by service with fields
  curl "{base_url}/api/v1/apiEndpoints?service=sample_api_service&fields=owners,tags,domains&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "id": "1f61427a-4a64-4070-9ac8-1d29302dac7c",
        "name": "addPet",
        "displayName": "Add Pet",
        "fullyQualifiedName": "sample_api_service.pet.addPet",
        "description": "add a new pet",
        "version": 0.1,
        "updatedAt": 1769982733987,
        "updatedBy": "admin",
        "endpointURL": "https://petstore3.swagger.io/#/pet/addPet",
        "requestMethod": "POST",
        "requestSchema": {
          "schemaType": "JSON",
          "schemaFields": [
            {"name": "id", "dataType": "INT", "description": "ID of pet"}
          ]
        },
        "href": "http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c",
        "owners": [],
        "tags": [],
        "service": {
          "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
          "type": "apiService",
          "name": "sample_api_service",
          "deleted": false
        },
        "serviceType": "Rest",
        "deleted": false,
        "domains": []
      }
    ],
    "paging": {
      "after": "...",
      "total": 8
    }
  }
  ```
</ResponseExample>

***

## Returns

Returns a paginated list of API endpoint objects. By default, only basic fields are included. Use the `fields` parameter to request additional data.

## Response

<ResponseField name="data" type="array">
  Array of API endpoint objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the API endpoint (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      API endpoint name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name in format `service.collection.endpointName`.
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Human-readable display name.
    </ResponseField>

    <ResponseField name="endpointURL" type="string">
      URL for the API endpoint.
    </ResponseField>

    <ResponseField name="requestMethod" type="string">
      HTTP request method.
    </ResponseField>

    <ResponseField name="service" type="object">
      Reference to the parent API service.
    </ResponseField>

    <ResponseField name="serviceType" type="string">
      Type of API service (e.g., Rest).
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners assigned to the API endpoint. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="tags" type="array" optional>
      Classification tags applied. Only included when `fields` contains `tags`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments for governance. Only included when `fields` contains `domains`.
    </ResponseField>

    <ResponseField name="extension" type="object" optional>
      Custom properties. Only included when `fields` contains `extension`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of API endpoints matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results. Null if this is the first page.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Supported Fields

The following fields can be requested via the `fields` query parameter:

| Field        | Description                        |
| ------------ | ---------------------------------- |
| `owners`     | Owner references (users and teams) |
| `tags`       | Classification tags                |
| `extension`  | Custom property values             |
| `domains`    | Domain assignments for governance  |
| `sourceHash` | Hash for change detection          |

***

## Error Handling

| Code  | Error Type     | Description                                 |
| ----- | -------------- | ------------------------------------------- |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token     |
| `403` | `FORBIDDEN`    | User lacks permission to list API endpoints |