Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
apiEndpoints
GET /v1/apiEndpoints
from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

configure(
    host="https://your-company.getcollate.io/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]}")
{
  "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
  }
}

List API Endpoints

List all API endpoints with optional filtering and pagination.

Query Parameters

apiCollection
string
Filter by API collection fully qualified name.
service
string
Filter by API service fully qualified name.
limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: owners, tags, extension, domains, sourceHash. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/apiEndpoints
from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

configure(
    host="https://your-company.getcollate.io/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]}")
{
  "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
  }
}

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

data
array
Array of API endpoint objects.
paging
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
ownersOwner references (users and teams)
tagsClassification tags
extensionCustom property values
domainsDomain assignments for governance
sourceHashHash for change detection

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list API endpoints