Projects

List projects

List projects that you have access to.

get

Authorizations

Query parameters

workspace_idstringoptional

Only needed when using the API as part of a plugin

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://felt.com/api/v2/projects' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

[
  {
    "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
    "links": {
      "self": "https://felt.com/api/v2/projects/V0dnOMOuTd9B9BOsL9C0UjmqC"
    },
    "name": "text",
    "type": "project_reference",
    "visibility": "workspace"
  }
]

Projects

Show a project

Returns details of a project including name, visibility, id and a list of references to the maps in the project.

get

Authorizations

Path parameters

project_idstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://felt.com/api/v2/projects/{project_id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
      "links": {
        "self": "https://felt.com/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
      },
      "project_id": "text",
      "public_access": "private",
      "thumbnail_url": "text",
      "title": "text",
      "type": "map_reference",
      "url": "text",
      "visited_at": "text"
    }
  ],
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}

Project

Create a project

Create a new project with the provided name and visibility.

post

Authorizations

Body

namestringrequired

The name to be used for the Project

visibilitystring · enumrequired

Either viewable by all members of the workspace, or private to users who are invited.

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/projects' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "visibility": "workspace"
  }'

200

401

403

404

422

429

500

200

{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
      "links": {
        "self": "https://felt.com/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
      },
      "project_id": "text",
      "public_access": "private",
      "thumbnail_url": "text",
      "title": "text",
      "type": "map_reference",
      "url": "text",
      "visited_at": "text"
    }
  ],
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}

Project

Update a project

Update a project's name or visibility.

post

Authorizations

Path parameters

project_idstringrequired

The ID of the project to update

Body

namestringoptional

The name to be used for the Project

visibilitystring · enumoptional

Either viewable by all members of the workspace, or private to users who are invited.

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/projects/{project_id}/update' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "visibility": "workspace"
  }'

200

401

403

404

422

429

500

200

{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
      "links": {
        "self": "https://felt.com/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
      },
      "project_id": "text",
      "public_access": "private",
      "thumbnail_url": "text",
      "title": "text",
      "type": "map_reference",
      "url": "text",
      "visited_at": "text"
    }
  ],
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}

Project

Delete a project

Delete a project and all of it's contents.

Caution: Deleting a project deletes all of the folders and maps inside!

delete

Authorizations

Path parameters

project_idstringrequired

The ID of the Project to delete. Note: This will delete all Folders and Maps inside the project!

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://felt.com/api/v2/projects/{project_id}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

422

429

500

204

No body

No Content