Console APIProjects
Retrieve project
GETapi.blutui.com/v1/agencies/{username}/projects/{id}
Retrieve a project in your agency.
Path parameters
idstringrequired
The ID of the project to retrieve.
Query parameters
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.get('9c17d680-e0af-4f00-9e28-08c4e38e89e0'){
"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
}idstring
The unique identifier for this project.
objectstring
This will always contain project for this endpoint.
namestring
The project name.
descriptionstring
The project description.
imagestring
The image URL of the project.
handlestring
The project handle.
passwordstring
The project password to access the project when under development.
timezonestring
The project timezone.
subdomainstring
The project subdomain.
primary_domainobject | string | null
The primary domain for this project.
publishedboolean
The project published status.
processedboolean
The project processed status.
created_attimestamp
The project's created at timestamp.
updated_attimestamp
The project's updated at timestamp.
deleted_attimestamp | null
The project's deleted at timestamp.
Last updated on