Projects

List projects

List projects that you have access to.

Get details of a project

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

Create a project

Create a new project with the provided name and visibility.

Update a project

Update a project's name or visibility.

Delete a project

Delete a project and all of it's contents.

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

PreviousEmbed Tokens NextGetting started

Last updated 13 days ago

Was this helpful?

delete

/api/v2/projects/{project_id}

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

cURL

JavaScript

Python

HTTP

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

204

401

403

404

422

429

500

No body

No Content

get

/api/v2/projects

Query parameters

workspace_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

422

429

500

[
  {
    "id": "luCHyMruTQ6ozGk3gPJfEB",
    "name": "text",
    "type": "project_reference",
    "visibility": "workspace"
  }
]

Projects

get

/api/v2/projects/{project_id}

Path parameters

project_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

422

429

500

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

Project

post

/api/v2/projects

Body

namestringrequired

The name to be used for the Project

visibilityenumrequired

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

Options: workspace, private

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

422

429

500

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

Project

post

/api/v2/projects/{project_id}/update

Path parameters

project_idstringrequired

The ID of the project to update

Body

namestring

The name to be used for the Project

visibilityenum

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

Options: workspace, private

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

422

429

500

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

Project