Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
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}: {ep.description}")

# 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", "domain"]
)

{
  "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

​
id
string
required
UUID of the API endpoint to retrieve.
​
fields
string
Comma-separated list of fields to include (e.g., owners,tags,extension,domains,sourceHash).
​
include
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.
​
fqn
string
required
Fully qualified name of the API endpoint (e.g., sample_api_service.pet.addPet).
​
fields
string
Comma-separated list of fields to include: owners, tags, extension, domains, sourceHash.
​
include
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}: {ep.description}")

# 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", "domain"]
)

{
  "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

​
id
string
Unique identifier for the API endpoint (UUID format).
​
name
string
API endpoint name.
​
fullyQualifiedName
string
Fully qualified name in format service.collection.endpointName.
​
displayName
string
Human-readable display name.
​
description
string
Description of the API endpoint in Markdown format.
​
endpointURL
string
URL for the API endpoint.
​
requestMethod
string
HTTP request method (GET, POST, PUT, PATCH, DELETE).
​
requestSchema
object
Schema describing the request body.
​
responseSchema
object
Schema describing the response body.
​
service
object
Reference to the parent API service.
​
serviceType
string
Type of API service (e.g., Rest).
​
version
number
Version number for the entity.
​
owners
array
List of owners. Only included when fields contains owners.
​
tags
array
Classification tags. Only included when fields contains tags.
​
domains
array
Domain assignments. Only included when fields contains domains.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this API endpoint
404NOT_FOUNDAPI endpoint with given ID or FQN does not exist