Sign upHelp Center

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
Query parameters
workspace_idstringOptional

Only needed when using the API as part of a plugin

Responses
200

Projects

application/json
get
GET /api/v2/projects HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_API_KEY
Accept: */*

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

Create project

post

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

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.

Possible values:
Responses
200

Project

application/json
post
POST /api/v2/projects HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "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"
    }
  ],
  "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
Path parameters
project_idstringRequired
Responses
200

Project

application/json
get
GET /api/v2/projects/{project_id} HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_API_KEY
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"
    }
  ],
  "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
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

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

No content

Update project

post

Update project properties including name and visibility settings.

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.

Possible values:
Responses
200

Project

application/json
post
POST /api/v2/projects/{project_id}/update HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "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"
    }
  ],
  "name": "text",
  "type": "project",
  "visibility": "workspace"
}
PreviousSourcesNextGetting started

Was this helpful?