Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadie Catalog API

Read Backstage software catalog entities in your Roadie tenant.

Roadie Catalog API is one of 6 APIs that Roadie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.roadie.so/api.

4 operations 4 paths 2 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.roadie.so/api/catalog
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Roadie Catalog API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Roadie API token (User Token or Service Token) created under Administration in the Roadie app. Passed as Authorization: Bearer YOURROADIEAPITOKEN.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Catalog 4

Read Backstage software catalog entities in your Roadie tenant.

GET
/catalog/entities
List catalog entities
listCatalogEntities 4 params → 200401
GET
/catalog/entities/by-query
Query catalog entities
queryCatalogEntities 3 params → 200401
GET
/catalog/entities/by-name/{kind}/{namespace}/{name}
Get a catalog entity by name
getCatalogEntityByName 3 params → 200401404
GET
/catalog/entity-facets
Get entity facets
getEntityFacets 2 params → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Entity (5 properties), Error (1 property). Each schema is shown below with its type and property counts.

Entity
object
A Backstage-format catalog entity.
5 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadie-io-catalog-api-openapi.yml Raw ↑

Other APIs Roadie publishes across the network.

Roadie MCP Servers
Roadie Entity Push API
Roadie Scaffolder API
Roadie Tech Insights API
Roadie TechDocs API