GET /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
print(f"{ep.fullyQualifiedName.root}: {ep.name.root}")

# Get by ID with fields
ep = APIEndpoints.retrieve(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    fields=["owners", "tags"]
)

# Get by fully qualified name
ep = APIEndpoints.retrieve_by_name("sample_api_service.pet.addPet")

# Get by name with fields
ep = APIEndpoints.retrieve_by_name(
    "sample_api_service.pet.addPet",
    fields=["owners", "tags", "domains"]
)

import org.openmetadata.schema.entity.data.APIEndpoint;

// client is an initialized OpenMetadataClient.

// Get by ID
APIEndpoint ep = client.apiEndpoints().get("1f61427a-4a64-4070-9ac8-1d29302dac7c");

// Get by ID with fields
APIEndpoint epWithFields = client.apiEndpoints().get(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    "owners,tags"
);

// Get by fully qualified name
APIEndpoint epByName = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet"
);

// Get by name with fields
APIEndpoint epByNameWithFields = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet",
    "owners,tags,domains"
);

# Get by ID
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

apiEndpoints

{id}

GET /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
print(f"{ep.fullyQualifiedName.root}: {ep.name.root}")

# Get by ID with fields
ep = APIEndpoints.retrieve(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    fields=["owners", "tags"]
)

# Get by fully qualified name
ep = APIEndpoints.retrieve_by_name("sample_api_service.pet.addPet")

# Get by name with fields
ep = APIEndpoints.retrieve_by_name(
    "sample_api_service.pet.addPet",
    fields=["owners", "tags", "domains"]
)

import org.openmetadata.schema.entity.data.APIEndpoint;

// client is an initialized OpenMetadataClient.

// Get by ID
APIEndpoint ep = client.apiEndpoints().get("1f61427a-4a64-4070-9ac8-1d29302dac7c");

// Get by ID with fields
APIEndpoint epWithFields = client.apiEndpoints().get(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    "owners,tags"
);

// Get by fully qualified name
APIEndpoint epByName = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet"
);

// Get by name with fields
APIEndpoint epByNameWithFields = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet",
    "owners,tags,domains"
);

# Get by ID
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Retrieve an API Endpoint

Get a single API endpoint by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the API endpoint to retrieve.

string

Comma-separated list of fields to include, for example owners,tags,extension,domains,sourceHash.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/apiEndpoints/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the API endpoint, for example sample_api_service.pet.addPet.

string

Comma-separated list of fields to include: owners, tags, extension, domains, sourceHash.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
print(f"{ep.fullyQualifiedName.root}: {ep.name.root}")

# Get by ID with fields
ep = APIEndpoints.retrieve(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    fields=["owners", "tags"]
)

# Get by fully qualified name
ep = APIEndpoints.retrieve_by_name("sample_api_service.pet.addPet")

# Get by name with fields
ep = APIEndpoints.retrieve_by_name(
    "sample_api_service.pet.addPet",
    fields=["owners", "tags", "domains"]
)

import org.openmetadata.schema.entity.data.APIEndpoint;

// client is an initialized OpenMetadataClient.

// Get by ID
APIEndpoint ep = client.apiEndpoints().get("1f61427a-4a64-4070-9ac8-1d29302dac7c");

// Get by ID with fields
APIEndpoint epWithFields = client.apiEndpoints().get(
    "1f61427a-4a64-4070-9ac8-1d29302dac7c",
    "owners,tags"
);

// Get by fully qualified name
APIEndpoint epByName = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet"
);

// Get by name with fields
APIEndpoint epByNameWithFields = client.apiEndpoints().getByName(
    "sample_api_service.pet.addPet",
    "owners,tags,domains"
);

# Get by ID
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Returns

Returns an API endpoint object with all requested fields populated.

Response

string

Unique identifier for the API endpoint (UUID format).

string

API endpoint name.

string

Fully qualified name in format service.collection.endpointName.

string

Human-readable display name.

string

Description of the API endpoint in Markdown format.

string

URL for the API endpoint.

string

HTTP request method (GET, POST, PUT, PATCH, DELETE).

object

Schema describing the request body.

Show properties

string

Type of schema, for example JSON.

array

Array of field definitions.

object

Schema describing the response body.

Show properties

string

Type of schema, for example JSON.

array

Array of field definitions.

object

Reference to the parent API service.

Show properties

string

UUID of the API service.

string

Type of entity (always apiService).

string

Name of the API service.

string

Type of API service, for example Rest.

number

Version number for the entity.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this API endpoint
`404`	`NOT_FOUND`	API endpoint with given ID or FQN does not exist

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Retrieve an API Endpoint

Retrieve an API Endpoint

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling