Skip to main content
POST
/
projects
Create a project
curl --request POST \
  --url https://web.subly.app/api/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "budget_amount": 123,
  "budget_period": "month",
  "budget_currency": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "budget_amount": 123,
  "budget_period": "month",
  "budget_currency": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your private API key for authentication. This key identifies your workspace for all requests.

Body

application/json
​
name
string
required

The name of the project.

​
budget_amount
number<float>

The financial budget allocated to the project.

​
budget_period
enum<string>

The time period the budget covers.

Available options:
month,
year
​
budget_currency
string

The ISO 4217 currency code for the budget amount (e.g., 'USD', 'AUD').

Response

Project created successfully.

​
id
string<uuid>

Unique identifier for the project.

​
name
string

The name of the project.

​
workspace_id
string<uuid>

Identifier of the workspace this project belongs to.

​
budget_amount
number<float>

The financial budget allocated to the project.

​
budget_period
enum<string>

The time period the budget covers.

Available options:
month,
year
​
budget_currency
string

The ISO 4217 currency code for the budget amount (e.g., 'USD', 'AUD').