GET /v1/apiCollections
from metadata.sdk import configure
from metadata.sdk.entities import APICollections
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
collections = APICollections.list(limit=50)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
# List all with auto-pagination
for ac in APICollections.list_all():
print(f"{ac.fullyQualifiedName}")
# Filter by service
collections = APICollections.list(
service="sample_api_service",
fields=["owners", "tags", "domain"],
limit=50
)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
if ac.owners:
print(f" Owners: {[o.name for o in ac.owners]}")
if ac.tags:
print(f" Tags: {[t.tagFQN for t in ac.tags]}")
import static org.openmetadata.sdk.fluent.APICollections.*;
// List first page
var result = APICollections.list()
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
// Filter by service with fields
var result = APICollections.list()
.service("sample_api_service")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/apiCollections?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"name": "pet",
"fullyQualifiedName": "sample_api_service.pet",
"version": 0.1,
"updatedAt": 1769982733673,
"updatedBy": "admin",
"endpointURL": "https://petstore3.swagger.io/#/pet",
"href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"owners": [],
"tags": [],
"service": {
"id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
"type": "apiService",
"name": "sample_api_service",
"fullyQualifiedName": "sample_api_service",
"deleted": false
},
"serviceType": "Rest",
"deleted": false,
"domains": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
List API Collections
List all API collections with optional filtering and pagination
GET
/
v1
/
apiCollections
GET /v1/apiCollections
from metadata.sdk import configure
from metadata.sdk.entities import APICollections
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
collections = APICollections.list(limit=50)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
# List all with auto-pagination
for ac in APICollections.list_all():
print(f"{ac.fullyQualifiedName}")
# Filter by service
collections = APICollections.list(
service="sample_api_service",
fields=["owners", "tags", "domain"],
limit=50
)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
if ac.owners:
print(f" Owners: {[o.name for o in ac.owners]}")
if ac.tags:
print(f" Tags: {[t.tagFQN for t in ac.tags]}")
import static org.openmetadata.sdk.fluent.APICollections.*;
// List first page
var result = APICollections.list()
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
// Filter by service with fields
var result = APICollections.list()
.service("sample_api_service")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/apiCollections?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"name": "pet",
"fullyQualifiedName": "sample_api_service.pet",
"version": 0.1,
"updatedAt": 1769982733673,
"updatedBy": "admin",
"endpointURL": "https://petstore3.swagger.io/#/pet",
"href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"owners": [],
"tags": [],
"service": {
"id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
"type": "apiService",
"name": "sample_api_service",
"fullyQualifiedName": "sample_api_service",
"deleted": false
},
"serviceType": "Rest",
"deleted": false,
"domains": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
List API Collections
List all API collections with optional filtering and pagination.Query Parameters
Filter by API service fully qualified name.
Maximum number of results to return (max: 1000000).
Cursor for backward pagination.
Cursor for forward pagination.
Comma-separated list of fields to include:
owners, tags, extension, domains, sourceHash. See Supported Fields below.Include
all, deleted, or non-deleted entities.GET /v1/apiCollections
from metadata.sdk import configure
from metadata.sdk.entities import APICollections
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
collections = APICollections.list(limit=50)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
# List all with auto-pagination
for ac in APICollections.list_all():
print(f"{ac.fullyQualifiedName}")
# Filter by service
collections = APICollections.list(
service="sample_api_service",
fields=["owners", "tags", "domain"],
limit=50
)
for ac in collections.data:
print(f"{ac.fullyQualifiedName}")
if ac.owners:
print(f" Owners: {[o.name for o in ac.owners]}")
if ac.tags:
print(f" Tags: {[t.tagFQN for t in ac.tags]}")
import static org.openmetadata.sdk.fluent.APICollections.*;
// List first page
var result = APICollections.list()
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
// Filter by service with fields
var result = APICollections.list()
.service("sample_api_service")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var ac : result.getData()) {
System.out.println(ac.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/apiCollections?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/apiCollections?service=sample_api_service&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"name": "pet",
"fullyQualifiedName": "sample_api_service.pet",
"version": 0.1,
"updatedAt": 1769982733673,
"updatedBy": "admin",
"endpointURL": "https://petstore3.swagger.io/#/pet",
"href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
"owners": [],
"tags": [],
"service": {
"id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
"type": "apiService",
"name": "sample_api_service",
"fullyQualifiedName": "sample_api_service",
"deleted": false
},
"serviceType": "Rest",
"deleted": false,
"domains": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
Returns
Returns a paginated list of API collection objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
Array of API collection objects.
Show properties
Show properties
Unique identifier for the API collection (UUID format).
API collection name.
Fully qualified name in format
service.collectionName.Human-readable display name.
Base URL for the API collection.
Reference to the parent API service.
Type of API service (e.g., Rest).
List of owners assigned to the API collection. Only included when
fields contains owners.Classification tags applied. Only included when
fields contains tags.Domain assignments for governance. Only included when
fields contains domains.Custom properties. Only included when
fields contains extension.Supported Fields
The following fields can be requested via thefields 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 collections |
Was this page helpful?
⌘I