Skip to main content
The blueprint.list procedure returns blueprints created by the authenticated user. Results include basic rating data and are ordered by creation date. Use the status and search filters to narrow results, and use page and limit to paginate through large libraries.

​
Request

Procedure type: query (HTTP GET) Endpoint: 
GET https://api.iblueprint.ai/api/trpc/blueprint.list

​
Parameters

​
input
object
required
A URL-encoded JSON object with a json key containing the parameters below.
​
json.page
number
Page number to retrieve. Must be 1 or higher. Defaults to 1.
​
json.limit
number
Number of blueprints per page. Must be between 1 and 100. Defaults to 20.
​
json.status
string
Filter by blueprint status. Accepted values: draft, published.
​
json.search
string
Case-insensitive substring search across title and description.

​
Response

​
data
array
Array of Blueprint objects owned by the authenticated user.
​
pagination
object
Pagination metadata.

​
Examples

curl -G "https://api.iblueprint.ai/api/trpc/blueprint.list" \
  --data-urlencode 'input={"json":{"page":1,"limit":20,"status":"published","search":"data pipeline"}}' \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  input: JSON.stringify({
    json: { page: 1, limit: 20, status: 'published', search: 'data pipeline' },
  }),
});

const response = await fetch(
  `https://api.iblueprint.ai/api/trpc/blueprint.list?${params}`,
  { headers: { Authorization: 'Bearer YOUR_API_KEY' } }
);

const { result } = await response.json();
const { data, pagination } = result.data.json;

​
Sample response

{
  "result": {
    "data": {
      "json": {
        "data": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "Data Pipeline Automation",
            "description": "Pulls from S3, transforms rows, and writes to BigQuery.",
            "status": "published",
            "visibility": "private",
            "version": "1.2.0",
            "tags": ["data", "etl"],
            "created_by": "user-uuid",
            "organization_id": "org-uuid",
            "created_at": "2024-11-01T09:00:00Z",
            "updated_at": "2024-11-15T14:22:00Z",
            "average_rating": 4.5,
            "rating_count": 12,
            "user_rating": 5
          }
        ],
        "pagination": {
          "page": 1,
          "limit": 20,
          "total": 1,
          "totalPages": 1
        }
      }
    }
  }
}