Logo

Docs

Responses

Common Body Responses.

SingleResourceResponse

Wrapper used when an endpoint returns one resource in data.

interface SingleResourceResponse<T> {
  data: T;
}

ListResourceResponse

Wrapper used when an endpoint returns a list in data.

interface ListResourceResponse<T> {
  data: T[];
  meta: {
    limit: number;
    offset: number;
    has_next_page: boolean;
  };
}

ErrorResponse

Standard error envelope returned by OpenMusic endpoints.

interface ErrorResponse {
  error: {
    code: number;
    title: string;
    message: string;
    trace_id: string | null;
  };
}

On this page