LogoLogo
Sign upHelp CenterContactSocial
Home
Home
  • Overview
  • REST API
    • Getting started
    • Navigating maps and workspaces
    • Uploading files and URLs
    • Styling layers
    • Refreshing live data layers
    • Working with elements
    • Listening to updates using webhooks
    • API Reference
      • Authentication
      • Maps
      • Layers
      • Elements
      • Users
      • Comments
      • Embed Tokens
      • Sources
      • Projects
  • JS SDK
    • Getting started
    • General concepts
    • Controlling maps
    • Working with selection
    • Reading entities
    • Drawing elements
    • Working with layers
    • Layer filters
    • Building custom charts
    • Map interactions and viewport
    • Hiding and showing
    • Integrating with React
    • Sample application
    • Examples
    • API Reference
  • Felt Style Language
    • Getting started
    • Style definition blocks
      • The config block
      • The paint block
      • The label block
      • The legend block
      • The popup block
      • The attributes block
      • The filters block
    • Types of visualizations
      • Simple visualizations
      • Categorical visualizations
      • Numeric visualizations (color & size)
      • Heatmaps
      • Hillshade
    • Zoom-based Styling
      • Interpolators
    • Legends
    • Errors
    • Examples
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. REST API
  2. API Reference

Projects

PreviousSourcesNextGetting started

Last updated 13 days ago

Was this helpful?

List projects

List projects that you have access to.

Show 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!

get
Authorizations
Query parameters
workspace_idstringOptional

Only needed when using the API as part of a plugin

Responses
200
Projects
application/json
401
UnauthorizedError
application/json
403
UnauthorizedError
application/json
404
NotFoundError
application/json
422
Unprocessable Entity
application/json
429
Unprocessable Entity
application/json
500
InternalServerError
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"
  }
]
get
Authorizations
Path parameters
project_idstringRequired
Responses
200
Project
application/json
401
UnauthorizedError
application/json
403
UnauthorizedError
application/json
404
NotFoundError
application/json
422
Unprocessable Entity
application/json
429
Unprocessable Entity
application/json
500
InternalServerError
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
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
401
UnauthorizedError
application/json
403
UnauthorizedError
application/json
404
NotFoundError
application/json
422
Unprocessable Entity
application/json
429
Unprocessable Entity
application/json
500
InternalServerError
application/json
delete
DELETE /api/v2/projects/{project_id} HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_API_KEY
Accept: */*

No content

  • List projects
  • GET/api/v2/projects
  • Show a project
  • GET/api/v2/projects/{project_id}
  • Create a project
  • POST/api/v2/projects
  • Update a project
  • POST/api/v2/projects/{project_id}/update
  • Delete a project
  • DELETE/api/v2/projects/{project_id}
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.

Possible values:
Responses
200
Project
application/json
401
UnauthorizedError
application/json
403
UnauthorizedError
application/json
404
NotFoundError
application/json
422
Unprocessable Entity
application/json
429
Unprocessable Entity
application/json
500
InternalServerError
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"
}
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.

Possible values:
Responses
200
Project
application/json
401
UnauthorizedError
application/json
403
UnauthorizedError
application/json
404
NotFoundError
application/json
422
Unprocessable Entity
application/json
429
Unprocessable Entity
application/json
500
InternalServerError
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"
}