Projects

Manage projects

Get projects of the account

get

Return the list of the projects of the account

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

Query parameters

_pageintegerOptional

Index of the page

Example: 0

_max_per_pageintegerOptional

Number of items per page

Example: 10

Responses

200

Success

application/json

current_item_countinteger · intOptional

Returns the number of items in the current page

current_pageinteger · intOptional

Returns the number of the current page

Default: 0

total_countinteger · intOptional

Returns the number of total items

items_per_pageinteger · intOptional

Returns the number of items per page

Default: 10

last_pageinteger · intOptional

Returns the index of the page

404

Not Found

get/accounts/{account_id}/projects

HTTPcURLJavaScriptPython

GET /v1/accounts/{account_id}/projects HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_item_count": 1,
  "current_page": 0,
  "total_count": 1,
  "items_per_page": 10,
  "last_page": 1,
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Create a project

post

Create a project

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

Body

application/json

idstringRead-onlyOptional

ID of the project

namestringRequired

Name of the project

Responses

201

Created

application/json

idstringRead-onlyOptional

ID of the project

namestringRequired

Name of the project

400

Validation errors

post/accounts/{account_id}/projects

HTTPcURLJavaScriptPython

POST /v1/accounts/{account_id}/projects HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text"
}

Get one project

get

Return one project by its id

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

project_idstringRequired

The ID of the project

Responses

200

Success

application/json

idstringRead-onlyOptional

ID of the project

namestringRequired

Name of the project

404

Not Found

get/accounts/{account_id}/projects/{project_id}

HTTPcURLJavaScriptPython

GET /v1/accounts/{account_id}/projects/{project_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text"
}

Delete a project

delete

Delete a project by its id.

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

project_idstringRequired

The ID of the project

Responses

204

Deleted

No content

404

Not Found

delete/accounts/{account_id}/projects/{project_id}

HTTPcURLJavaScriptPython

DELETE /v1/accounts/{account_id}/projects/{project_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Update a project

patch

Update project informations - You can set only the properies you want to update in the request body.

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

project_idstringRequired

The ID of the project

Body

application/json

idstringRead-onlyOptional

ID of the project

namestringRequired

Name of the project

Responses

200

Updated

application/json

idstringRead-onlyOptional

ID of the project

namestringRequired

Name of the project

400

Validation errors

patch/accounts/{account_id}/projects/{project_id}

HTTPcURLJavaScriptPython

PATCH /v1/accounts/{account_id}/projects/{project_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text"
}

Toggle a project state

patch

Switch the state of the project to active/inactive.

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

project_idstringRequired

The ID of the project

Body

application/json

statestring · enumRequired

State of the toggler

Possible values:

Responses

200

Updated

No content

404

Not Found

patch/accounts/{account_id}/projects/{project_id}/toggle

HTTPcURLJavaScriptPython

PATCH /v1/accounts/{account_id}/projects/{project_id}/toggle HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "state": "draft"
}

No content