Get all entities with full relationship data

GET

/v1/projects/{projectId}/entities

Returns a comprehensive view of all entities in the project organized by type. Includes services, messaging topics, categories, owners, and flows with their complete relationship data. This endpoint provides a full data model suitable for building custom visualizations, reports, or exports.

Authorizations

• SessionAuth
• ApiKeyAuth

Parameters

Path Parameters

projectId

required

An identifier (e.g., my-project-a1b2c)

string

>= 8 characters <= 60 characters /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Query Parameters

at

ISO-8601 timestamp to retrieve the project state at a specific point in time. If omitted, returns the current state.

string format: date-time

Responses

200

Complete entity data with all relationships indexed by entity ID

All entities and their relationships in a project

object

services

required

Service entities indexed by ID

object

key

additional properties

object

id

required

Unique identifier for the entity

string

name

required

Name of the entity

string

type

required

Type of entity

string

Allowed values: Service Messaging Category Owner Flow

slug

URL-friendly slug of the service

string

description

A description of this service

string

flows

The flows that this service belongs to

Array<string>

category

Category ID this service belongs to

string

owner

Owner ID of this service

string

produces

IDs of messaging topics this service produces to

Array<string>

consumes

IDs of messaging topics this service consumes from

Array<string>

extras

Custom key-value fields

object

key

additional properties

string

messaging

required

Messaging entities indexed by ID

object

key

additional properties

object

id

required

Unique identifier for the entity

string

name

required

Name of the entity

string

type

required

Type of entity

string

Allowed values: Service Messaging Category Owner Flow

category

Category ID this messaging entity belongs to

string

owner

Owner ID of this messaging entity

string

flows

Flow IDs that this messaging entity belongs to

Array<string>

consumers

IDs of services that consume this topic

Array<string>

producers

IDs of services that produce to this topic

Array<string>

extras

Custom key-value fields

object

key

additional properties

string

categories

required

Category entities indexed by ID

object

key

additional properties

object

id

required

Unique identifier for the entity

string

name

required

Name of the entity

string

type

required

Type of entity

string

Allowed values: Service Messaging Category Owner Flow

color

required

Color for visual representation

string

services

IDs of services in this category

Array<string>

messaging

IDs of messaging topics in this category

Array<string>

owners

required

Owner entities indexed by ID

object

key

additional properties

object

id

required

Unique identifier for the entity

string

name

required

Name of the entity

string

type

required

Type of entity

string

Allowed values: Service Messaging Category Owner Flow

color

required

Color for visual representation

string

services

IDs of services owned by this owner

Array<string>

messaging

IDs of messaging topics owned by this owner

Array<string>

flows

required

Flow entities indexed by ID

object

key

additional properties

object

id

required

Unique identifier for the entity

string

name

required

Name of the entity

string

type

required

Type of entity

string

Allowed values: Service Messaging Category Owner Flow

color

required

Color for visual representation

string

services

IDs of services participating in this flow

Array<string>

messaging

IDs of messaging topics used in this flow

Array<string>

401

Unauthorized, authentication required

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters

404

Project not found

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters

429

Too many requests

Rate limit exceeded error response

object

status

required

HTTP status code

integer

Example

429

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Too many requests

retryAfter

required

Number of seconds until the client can retry

integer

Example

60

Headers

Retry-After

integer

Number of seconds to wait before retrying

500

Internal server error

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters