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: 100Optional

Maximum number of items to return (default: 10)

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

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-01-08T00:36:21.094Z",
      "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

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-01-08T00:36:21.094Z",
    "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, status, completion state, date range, search text, and author.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Query parameters

limitinteger · min: 1 · max: 100Optional

Maximum number of items to return (default: 10)

Default: 10

starting_afterstringOptional

Cursor for pagination. Returns items after this cursor value.

ending_beforestringOptional

Cursor for pagination. Returns items before this cursor value.

branchstringOptional

Filter runs by git branch name

Example: main

tagstring[]Optional

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

authorstring[]Optional

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

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-01-08T00:36:21.094Z",
      "durationMs": 1,
      "tags": [
        "text"
      ],
      "previousRunId": "text",
      "cursor": "text",
      "timeout": {
        "isTimeout": true,
        "timeoutValueMs": 1
      },
      "cancellation": {},
      "groups": [
        {
          "groupId": "text",
          "platform": {
            "osName": "text",
            "osVersion": "text",
            "browserName": "text",
            "browserVersion": "text"
          },
          "tests": {
            "overall": 1,
            "passes": 1,
            "failures": 1,
            "pending": 1,
            "skipped": 1,
            "flaky": 1
          }
        }
      ],
      "meta": {
        "ciBuildId": "text",
        "commit": {
          "sha": "text",
          "branch": "text",
          "authorName": "text",
          "authorEmail": "text",
          "message": "text",
          "remoteOrigin": "text"
        },
        "framework": {
          "name": "text",
          "version": "text"
        }
      },
      "completionState": "text",
      "status": "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:

tagsstring[]Optional

Filter by tags (can be specified multiple times)

branchesstring[]Optional

Filter by branches (can be specified multiple times)

groupsstring[]Optional

Filter by groups (can be specified multiple times)

authorsstring[]Optional

Filter by git authors (can be specified multiple times)

Responses

200

Successful response

application/json

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-01-08T00%3A36%3A21.094Z&date_end=2026-01-08T00%3A36%3A21.094Z HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "projectId": "text",
    "orgId": "text",
    "dateStart": "2026-01-08T00:36:21.094Z",
    "dateEnd": "2026-01-08T00:36:21.094Z",
    "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
            }
          }
        }
      ]
    }
  }
}