API ReferenceConsole APIProjects

List all projects

GETapi.blutui.com/v1/agencies/{username}/projects

List all projects in your agency.

Query parameters

limitinteger | default: 10

Limit the number of objects to return, ranging between 1 and 20.

pageinteger | default: 1

The current page used to display the pagination results.

expandstring[]

Expand the response for the given items. Expand array accepts primary_domain.

Response

import Blutui from 'blutui'

const blutui = new Blutui('ey....')

blutui.agency('studio').projects.list()
JSON Response
{
  "object": "list",
  "data": [
    {
      "id": "9c17d680-e0af-4f00-9e28-08c4e38e89e0",
      "object": "project",
      "name": "Example Site",
      "description": "This is an example site.",
      "image": "https://example.com/image.jpg",
      "handle": "example-site",
      "password": "password",
      "timezone": "Pacific/Auckland",
      "subdomain": "example-site",
      "primary_domain": "9c17d63b-96c0-4315-b4dd-e55373ce4ffd",
      "published": true,
      "processed": true,
      "created_at": 1711305486,
      "updated_at": 1711305486,
      "deleted_at": 1711305486
    },
    {...},
    {...}
  ],
  "meta": {
    "has_more": false,
    "current_page": 1,
    "from": 1,
    "to": 3,
    "total": 3,
    "per_page": 10,
    "last_page": 1
  }
}
objectstring

This will always contain list for this endpoint.

dataarray

An array of up to limit project resources. If no projects are available, an empty array is returned.

metaobject

Additional information about the list.

Last updated on