Skip to content
Blupinta

The projects it may read

GET
/v1/projects
curl --request GET \
  --url https://api.blupinta.app/v1/projects \
  --header 'Authorization: Bearer <token>'

The projects the person chose when connecting the app, by name, each with its last saved version.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

The projects it may read

Media typeapplication/json

The projects an app may read, by name: one page of them

object
rows
required
Array<object>

A project an app may read

object
id
required
string
name
required

Its name, as its people wrote it

string
address
required

Where the home is, when they wrote it; null otherwise

string | null
lastRevision
required
Any of:
object
number
required
integer
createdAt
required

When it was saved, ISO 8601

string
next
required

Where the next page starts; null on the last page (today every project fits on one)

string | null
Examplegenerated
{
  "rows": [
    {
      "id": "example",
      "name": "example",
      "address": "example",
      "lastRevision": {
        "number": 1,
        "createdAt": "example"
      }
    }
  ],
  "next": "example"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The requests the caller may make in the window: an app counts per connection, every token together

RateLimit-Remaining
integer

The requests left in the window

RateLimit-Reset
integer

Seconds until the window starts again

401

Section titled “401”

unauthenticated: No valid access token for this API

Media typeapplication/json

The body of a refusal

object
error
required

What /v1 answers when it refuses

string
Allowed values: unauthenticated forbidden not_found rate_limited server_error invalid_input conflict invalid_home blocking_problems unsupported_file
errorId

The server’s id for a server_error, to quote when asking for help

string
problems

What is wrong, for invalid_input, conflict, invalid_home, blocking_problems

Array<string>
Example
{
  "error": "unauthenticated"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The requests the caller may make in the window: an app counts per connection, every token together

RateLimit-Remaining
integer

The requests left in the window

RateLimit-Reset
integer

Seconds until the window starts again

403

Section titled “403”

forbidden: The token lacks the scope this operation needs

Media typeapplication/json

The body of a refusal

object
error
required

What /v1 answers when it refuses

string
Allowed values: unauthenticated forbidden not_found rate_limited server_error invalid_input conflict invalid_home blocking_problems unsupported_file
errorId

The server’s id for a server_error, to quote when asking for help

string
problems

What is wrong, for invalid_input, conflict, invalid_home, blocking_problems

Array<string>
Example
{
  "error": "unauthenticated"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The requests the caller may make in the window: an app counts per connection, every token together

RateLimit-Remaining
integer

The requests left in the window

RateLimit-Reset
integer

Seconds until the window starts again

429

Section titled “429”

rate_limited: Too many requests: wait as long as Retry-After says

Media typeapplication/json

The body of a refusal

object
error
required

What /v1 answers when it refuses

string
Allowed values: unauthenticated forbidden not_found rate_limited server_error invalid_input conflict invalid_home blocking_problems unsupported_file
errorId

The server’s id for a server_error, to quote when asking for help

string
problems

What is wrong, for invalid_input, conflict, invalid_home, blocking_problems

Array<string>
Example
{
  "error": "unauthenticated"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The requests the caller may make in the window: an app counts per connection, every token together

RateLimit-Remaining
integer

The requests left in the window

RateLimit-Reset
integer

Seconds until the window starts again

Retry-After
integer

Seconds to wait before asking again

500

Section titled “500”

server_error: Something failed on Blupinta’s side: quote errorId when asking for help

Media typeapplication/json

The body of a refusal

object
error
required

What /v1 answers when it refuses

string
Allowed values: unauthenticated forbidden not_found rate_limited server_error invalid_input conflict invalid_home blocking_problems unsupported_file
errorId

The server’s id for a server_error, to quote when asking for help

string
problems

What is wrong, for invalid_input, conflict, invalid_home, blocking_problems

Array<string>
Example
{
  "error": "unauthenticated"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The requests the caller may make in the window: an app counts per connection, every token together

RateLimit-Remaining
integer

The requests left in the window

RateLimit-Reset
integer

Seconds until the window starts again