v1

latestOpenAPI 3.1.02026-07-265094114.0 KB

Projects

Retrieve Projects

Retrieve all Projects in your workspace

get/v1/projects

Query parameters

userIdstring

Example:usr_535B1EC15F5F41EAB1B400E9ED4077B6

The user Id associated with the workspace

namestring

Example:My Project

Filter by the project name

limitnumber

Example:50

The maximum number of results to return

pagenumber

Example:1

The number of results to skip before starting to collect the results

Example:LAST_UPDATED

The sorting order for the projects

createdAtStartstring

Example:2021-09-01T00:00:00.000Z

Start date for the created at filter

createdAtEndstring

Example:2021-09-01T00:00:00.000Z

End date for the created at filter

qstring

Example:userId:usr_535B1EC15F5F41EAB1B400E9ED4077B6 AND metadata[source]:crm

IQ-style search query. Combine up to 10 filters with AND. Supported tokens: userId:<id> (equality on the project owner), metadata[<key>]:<value> (equality on the project metadata JSONB column). Example: userId:usr_535B1EC15F5F41EAB1B400E9ED4077B6 AND metadata[source]:crm. The query is matched in SQL against the projects table — every recognised token contributes an additive AND predicate to the underlying where clause.

Response

List of projects

requestIdstring required

resourcestring required

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "projects",
  "data": [
    {
      "id": "prj_073D2D49094A4AED991A47B614522579",
      "name": "My Canvas",
      "userId": "usr_073D2D49094A4AED991A47B614522579",
      "appUrl": "https://app.jasper.ai/canvas/edit/962e4d4c-ffdc-4c7a-83e3-8f4e715004cf",
      "accessLevel": "PRIVATE",
      "settings": {
        "goal": "Launch announcement for Q3 product release",
        "toneId": "ton_535B1EC15F5F41EAB1B400E9ED4077B6",
        "audienceId": "aud_535B1EC15F5F41EAB1B400E9ED4077B6",
        "styleId": "sty_535B1EC15F5F41EAB1B400E9ED4077B6",
        "knowledgeIds": [
          "kno_535B1EC15F5F41EAB1B400E9ED4077B6"
        ]
      },
      "metadata": {
        "externalId": "ext_123",
        "source": "crm"
      }
    }
  ]
}