Ctrlk
Sign upHelp CenterContactSocial
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Projects

APIs to organize maps

Projects help you organize maps and manage team permissions.

With these APIs, you can manage the projects in your workspace.

List projects

get

Retrieve all projects accessible to the authenticated user within the workspace.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
workspace_idstringOptional

Only needed when using the API as part of a plugin

Responses
200

Projects

application/json
idstring · felt_idRequiredExample: luCHyMruTQ6ozGk3gPJfEB
max_inherited_permissionstring · enumRequired

The maximum permission level workspace members inherit on team-visible projects.

Example: view_onlyPossible values:
namestringRequired
typestring · enumRequiredPossible values:
visibilitystring · enumRequiredPossible values:
get/api/v2/projects
GET /api/v2/projects HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create project

post

Create a new project with specified name and visibility settings within the workspace.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
max_inherited_permissionstring · enumOptional

The maximum permission level workspace members inherit on team-visible projects. Only applicable when visibility is "workspace".

Example: view_onlyPossible values:
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.

Possible values:
Responses
200

Project

application/json
idstring · felt_idRequiredExample: luCHyMruTQ6ozGk3gPJfEB
max_inherited_permissionstring · enumRequired

The maximum permission level workspace members inherit on team-visible projects.

Example: view_onlyPossible values:
namestringRequired
typestring · enumRequiredPossible values:
visibilitystring · enumRequiredPossible values:
post/api/v2/projects
POST /api/v2/projects HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "max_inherited_permission": "view_only",
  "name": "text",
  "visibility": "workspace"
}
{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "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"
    }
  ],
  "max_inherited_permission": "view_only",
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}

Get project

get

Retrieve detailed information about a specific project including metadata, permissions, and references to the maps in the project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idstringRequired
Responses
200

Project

application/json
idstring · felt_idRequiredExample: luCHyMruTQ6ozGk3gPJfEB
max_inherited_permissionstring · enumRequired

The maximum permission level workspace members inherit on team-visible projects.

Example: view_onlyPossible values:
namestringRequired
typestring · enumRequiredPossible values:
visibilitystring · enumRequiredPossible values:
get/api/v2/projects/{project_id}
GET /api/v2/projects/{project_id} HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "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"
    }
  ],
  "max_inherited_permission": "view_only",
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}

Delete project

delete

Permanently delete a project and all its contained maps and folders.

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idstringRequired

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

Responses
204

No Content

No content
delete/api/v2/projects/{project_id}
DELETE /api/v2/projects/{project_id} HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update project

post

Update project properties including name and visibility settings.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idstringRequired

The ID of the project to update

Body
max_inherited_permissionstring · enumOptional

The maximum permission level workspace members inherit on team-visible projects. Only applicable when visibility is "workspace".

Example: view_onlyPossible values:
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.

Possible values:
Responses
200

Project

application/json
idstring · felt_idRequiredExample: luCHyMruTQ6ozGk3gPJfEB
max_inherited_permissionstring · enumRequired

The maximum permission level workspace members inherit on team-visible projects.

Example: view_onlyPossible values:
namestringRequired
typestring · enumRequiredPossible values:
visibilitystring · enumRequiredPossible values:
post/api/v2/projects/{project_id}/update
POST /api/v2/projects/{project_id}/update HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "max_inherited_permission": "view_only",
  "name": "text",
  "visibility": "workspace"
}
{
  "id": "luCHyMruTQ6ozGk3gPJfEB",
  "maps": [
    {
      "created_at": "2024-05-25T15:51:34",
      "folder_id": "text",
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "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"
    }
  ],
  "max_inherited_permission": "view_only",
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}
PreviousSources
NextGetting started

Last updated

Was this helpful?