Projects

Manage and query projects in your organization.

Projects are the top-level containers for test runs, specs, and test results. Each project has a unique project ID and can be configured with various settings.

List projects

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects

Get all projects for your organization with optional pagination

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Query parameters

limitinteger · min: 1 · max: 50Optional

Maximum number of items to return (default: 10, max: 50)

Default: 10

starting_afterstringOptional

Cursor for pagination. Returns items after this cursor value.

ending_beforestringOptional

Cursor for pagination. Returns items before this cursor value.

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

has_morebooleanRequired

Whether there are more items to fetch

400

Invalid request parameters

application/json

401

Authentication failed

application/json

get/projects

HTTPcURLJavaScriptPython

GET /v1/projects HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "has_more": true,
  "data": [
    {
      "projectId": "text",
      "name": "text",
      "createdAt": "2026-07-10T05:45:53.595Z",
      "failFast": true,
      "inactivityTimeoutSeconds": 1,
      "defaultBranchName": "text",
      "cursor": "text"
    }
  ]
}

Get project

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}

Get a single project by ID

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get/projects/{projectId}

HTTPcURLJavaScriptPython

GET /v1/projects/{projectId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "projectId": "text",
    "name": "text",
    "createdAt": "2026-07-10T05:45:53.595Z",
    "failFast": true,
    "inactivityTimeoutSeconds": 1,
    "defaultBranchName": "text"
  }
}

List project runs

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/runs

Get all runs for a project with optional pagination and filtering. Supports filtering by branch, tags, environment, status, completion state, date range, search text, author, and pull request id (pr_id maps to meta.pr.id).

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Query parameters

limitinteger · min: 1 · max: 50Optional

Maximum number of items to return (default: 10, max: 50)

Default: 10

starting_afterstringOptional

Cursor for pagination. Returns items after this cursor value.

ending_beforestringOptional

Cursor for pagination. Returns items before this cursor value.

tags[]string[]Optional

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Example: ["tag1","tag2"]

authors[]string[]Optional

Filter by git authors (can be specified multiple times using bracket notation, e.g., authors[]=author1&authors[]=author2)

Example: ["author1","author2"]

environments[]string[]Optional

Filter by environment (can be specified multiple times using bracket notation, e.g., environments[]=staging&environments[]=production)

Example: ["staging","production"]

branchone ofOptionalDeprecated

Branch filter value: an exact branch name, or a trailing * for prefix match (e.g. release/*). Max 250 characters.

Example: main

string · max: 250Optional

Exact branch name (must not contain * or spaces).

Pattern: ^[!-)+-~]+$

or

string · max: 250Optional

Prefix match: branch prefix followed by *.

Pattern: ^[!-)+-~]+\*$

tagstring[]OptionalDeprecated

Deprecated. Use tags[] instead. Filter runs by tags (can be specified multiple times). Use tag_operator to control matching behavior.

Example: ["workflow-master","nightly"]

tag_operatorstring · enumOptional

Logical operator for tag filtering. AND requires all tags to be present (default), OR requires any tag to be present.

Default: ANDExample: ANDPossible values:

searchstring · max: 200Optional

Search runs by ciBuildId or commit message. Case-insensitive.

Example: fix login bug

pr_idstring · min: 1 · max: 128Optional

Filter runs by normalized pull request id (stored as meta.pr.id). Printable ASCII only, max 128 characters.

Example: 42Pattern: ^[!-~]+$

authorstring[]OptionalDeprecated

Deprecated. Use authors[] instead. Filter runs by git commit author name (can be specified multiple times).

Example: ["John Doe"]

date_startstring · date-timeOptional

Filter runs created on or after this date (ISO 8601 format).

Example: 2024-01-01T00:00:00Z

date_endstring · date-timeOptional

Filter runs created before this date (ISO 8601 format).

Example: 2024-12-31T23:59:59Z

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

has_morebooleanRequired

Whether there are more items to fetch

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get/projects/{projectId}/runs

HTTPcURLJavaScriptPython

GET /v1/projects/{projectId}/runs HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "has_more": true,
  "data": [
    {
      "runId": "text",
      "projectId": "text",
      "createdAt": "2026-07-10T05:45:53.595Z",
      "durationMs": 1,
      "tags": [
        "text"
      ],
      "environments": [
        "text"
      ],
      "previousRunId": "text",
      "cursor": "text",
      "timeout": {
        "isTimeout": true,
        "timeoutValueMs": 1
      },
      "cancellation": {},
      "groups": [
        {
          "groupId": "text",
          "platform": {
            "osName": "text",
            "osVersion": "text",
            "browserName": "text",
            "browserVersion": "text"
          },
          "tags": [
            "text"
          ],
          "environment": "text",
          "createdAt": "2026-07-10T05:45:53.595Z",
          "coverageEnabled": true,
          "durationMs": 1,
          "specCount": 1,
          "instances": {
            "overall": 1,
            "claimed": 1,
            "complete": 1,
            "passes": 1,
            "failures": 1
          },
          "tests": {
            "total": 1,
            "recorded": 1,
            "passes": 1,
            "failures": 1,
            "pending": 1,
            "retries": 1,
            "skipped": 1,
            "flaky": 1
          }
        }
      ],
      "meta": {
        "ciBuildId": "text",
        "pr": {
          "id": "text",
          "link": "text",
          "title": "text",
          "source": "text",
          "destination": "text"
        },
        "commit": {
          "sha": "text",
          "branch": "text",
          "authorName": "text",
          "authorEmail": "text",
          "message": "text",
          "remoteOrigin": "text"
        },
        "framework": {
          "name": "text",
          "version": "text"
        }
      },
      "completionState": "text",
      "status": "text"
    }
  ]
}

List pull requests

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/pull-requests

Lists pull requests for this project together with summarized run activity. Each result includes rollup stats for the PR, its most recent run, and an optional preview of additional runs (runs_per_pr: default 1, max 10). Optional filters narrow the list by branches[], tags[], authors[], or run status; the status shown corresponds to each pull request’s latest run that matches your filters. Branch values may end with * for a prefix match. Pagination uses opaque tokens: advance with starting_after, go back with ending_before; use the returned cursor from each item as the token and keep the same filter set across pages. Sending both cursor parameters at once is not supported. Because new runs can arrive while you page, a pull request can occasionally move between pages or appear twice in sequence—repeat the same filters on every request so results stay consistent.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Query parameters

limitinteger · min: 1 · max: 50Optional

Maximum number of items to return (default: 10, max: 50)

Default: 10

starting_afterstringOptional

Cursor for pagination. Returns items after this cursor value.

ending_beforestringOptional

Cursor for pagination. Returns items before this cursor value.

runs_per_printeger · min: 1 · max: 10Optional

How many most recent runs to include in each card’s timelinePreview (does not cap total stats).

Default: 1

tags[]string[]Optional

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Example: ["tag1","tag2"]

tag_operatorstring · enumOptional

Logical operator for tag filtering. AND requires all tags to be present (default), OR requires any tag to be present.

Default: ANDExample: ANDPossible values:

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

has_morebooleanRequired

Whether more PR rows exist after this page

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get/projects/{projectId}/pull-requests

HTTPcURLJavaScriptPython

GET /v1/projects/{projectId}/pull-requests HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "has_more": true,
  "data": [
    {
      "pr": {
        "id": "text",
        "prNumber": "text",
        "link": "text",
        "title": "text",
        "source": "text",
        "destination": "text"
      },
      "stats": {
        "total": 1,
        "passed": 1,
        "failed": 1,
        "running": 1,
        "failing": 1
      },
      "latestRun": {
        "runId": "text",
        "projectId": "text",
        "createdAt": "2026-07-10T05:45:53.595Z",
        "durationMs": 1,
        "tags": [
          "text"
        ],
        "environments": [
          "text"
        ],
        "previousRunId": "text",
        "cursor": "text",
        "timeout": {
          "isTimeout": true,
          "timeoutValueMs": 1
        },
        "cancellation": {},
        "groups": [
          {
            "groupId": "text",
            "platform": {
              "osName": "text",
              "osVersion": "text",
              "browserName": "text",
              "browserVersion": "text"
            },
            "tags": [
              "text"
            ],
            "environment": "text",
            "createdAt": "2026-07-10T05:45:53.595Z",
            "coverageEnabled": true,
            "durationMs": 1,
            "specCount": 1,
            "instances": {
              "overall": 1,
              "claimed": 1,
              "complete": 1,
              "passes": 1,
              "failures": 1
            },
            "tests": {
              "total": 1,
              "recorded": 1,
              "passes": 1,
              "failures": 1,
              "pending": 1,
              "retries": 1,
              "skipped": 1,
              "flaky": 1
            }
          }
        ],
        "meta": {
          "ciBuildId": "text",
          "pr": {
            "id": "text",
            "link": "text",
            "title": "text",
            "source": "text",
            "destination": "text"
          },
          "commit": {
            "sha": "text",
            "branch": "text",
            "authorName": "text",
            "authorEmail": "text",
            "message": "text",
            "remoteOrigin": "text"
          },
          "framework": {
            "name": "text",
            "version": "text"
          }
        },
        "completionState": "text",
        "status": "text"
      },
      "timelinePreview": [
        {
          "runId": "text",
          "projectId": "text",
          "createdAt": "2026-07-10T05:45:53.595Z",
          "durationMs": 1,
          "tags": [
            "text"
          ],
          "environments": [
            "text"
          ],
          "previousRunId": "text",
          "cursor": "text",
          "timeout": {
            "isTimeout": true,
            "timeoutValueMs": 1
          },
          "cancellation": {},
          "groups": [
            {
              "groupId": "text",
              "platform": {
                "osName": "text",
                "osVersion": "text",
                "browserName": "text",
                "browserVersion": "text"
              },
              "tags": [
                "text"
              ],
              "environment": "text",
              "createdAt": "2026-07-10T05:45:53.595Z",
              "coverageEnabled": true,
              "durationMs": 1,
              "specCount": 1,
              "instances": {
                "overall": 1,
                "claimed": 1,
                "complete": 1,
                "passes": 1,
                "failures": 1
              },
              "tests": {
                "total": 1,
                "recorded": 1,
                "passes": 1,
                "failures": 1,
                "pending": 1,
                "retries": 1,
                "skipped": 1,
                "flaky": 1
              }
            }
          ],
          "meta": {
            "ciBuildId": "text",
            "pr": {
              "id": "text",
              "link": "text",
              "title": "text",
              "source": "text",
              "destination": "text"
            },
            "commit": {
              "sha": "text",
              "branch": "text",
              "authorName": "text",
              "authorEmail": "text",
              "message": "text",
              "remoteOrigin": "text"
            },
            "framework": {
              "name": "text",
              "version": "text"
            }
          },
          "completionState": "text",
          "status": "text"
        }
      ],
      "hasMoreRuns": true,
      "cursor": "text"
    }
  ]
}

Get project insights

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/insights

Get aggregated run and test metrics for a project within a date range

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Query parameters

date_startstring · date-timeRequired

Start date in ISO 8601 format

Example: 2024-01-01T00:00:00.000Z

date_endstring · date-timeRequired

End date in ISO 8601 format

Example: 2024-01-31T23:59:59.999Z

resolutionstring · enumOptional

Time resolution for histogram data

Default: 1dPossible values:

tags[]string[]Optional

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Example: ["tag1","tag2"]

groups[]string[]Optional

Filter by groups (can be specified multiple times using bracket notation, e.g., groups[]=group1&groups[]=group2)

Example: ["group1","group2"]

authors[]string[]Optional

Filter by git authors (can be specified multiple times using bracket notation, e.g., authors[]=author1&authors[]=author2)

Example: ["author1","author2"]

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get/projects/{projectId}/insights

HTTPcURLJavaScriptPython

GET /v1/projects/{projectId}/insights?date_start=2026-07-10T05%3A45%3A53.595Z&date_end=2026-07-10T05%3A45%3A53.595Z HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "projectId": "text",
    "orgId": "text",
    "dateStart": "2026-07-10T05:45:53.595Z",
    "dateEnd": "2026-07-10T05:45:53.595Z",
    "resolution": "text",
    "results": {
      "overall": {
        "runs": {
          "total": 1,
          "cancelled": 1,
          "timeouts": 1,
          "completed": 1,
          "failed": 1,
          "passed": 1,
          "nonFullyReported": 1,
          "avgDurationSeconds": 1,
          "avgSuccessRate": 1
        },
        "tests": {
          "total": 1,
          "failed": 1,
          "passed": 1,
          "pending": 1,
          "skipped": 1,
          "flaky": 1
        }
      },
      "timeline": [
        {
          "ANY_ADDITIONAL_PROPERTY": {
            "runs": {
              "total": 1,
              "cancelled": 1,
              "timeouts": 1,
              "completed": 1,
              "failed": 1,
              "passed": 1,
              "nonFullyReported": 1,
              "avgDurationSeconds": 1,
              "avgSuccessRate": 1
            },
            "tests": {
              "total": 1,
              "failed": 1,
              "passed": 1,
              "pending": 1,
              "skipped": 1,
              "flaky": 1
            }
          }
        }
      ]
    }
  }
}

List project terms for a single type

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/terms/{termType}

Returns cursor-paginated terms for one kind (tag, branch, authorName, etc.). Rows are ordered by each term's last update time; use dir as asc or desc (default desc, most recently updated first). Page with starting_after or ending_before using the opaque cursor value from a returned item; do not send both cursors in one request. Reuse the same dir, limit, search filter, and path when requesting additional pages.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

termTypestring · enumRequired

Term kind to list

Possible values:

Query parameters

limitinteger · min: 1 · max: 100Optional

Maximum number of terms to return (default: 100, max: 100)

Default: 100

dirstring · enumOptional

Sort direction: desc (default) or asc.

Default: descPossible values:

starting_afterstringOptional

Cursor for pagination. Returns items after this cursor value.

ending_beforestringOptional

Cursor for pagination. Returns items before this cursor value.

searchstring · max: 128Optional

Optional case-insensitive prefix filter on term values (up to 128 characters)

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

has_morebooleanRequired

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get/projects/{projectId}/terms/{termType}

HTTPcURLJavaScriptPython

GET /v1/projects/{projectId}/terms/{termType} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "has_more": true,
  "data": [
    {
      "id": "text",
      "name": "text",
      "count": 1,
      "updated_at": "2026-07-10T05:45:53.595Z",
      "cursor": "text"
    }
  ]
}