List projects

GET/projects

Base URL https://arcus.testsigma.com/api/v1

Retrieves a paginated list of projects, with optional filtering by query parameters.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Query parameters

`page_size`	Number of projects to return per page.
`name__NEQ`	Excludes projects whose name matches the given value.

Response attributes

`message`	Status message for the request; may be empty.
`data.projects[].id`	Unique identifier of the project.
`data.projects[].created_at`	Unix timestamp of when the project was created.
`data.projects[].updated_at`	Unix timestamp of the last update to the project.
`data.projects[].name`	Name of the project.
`data.projects[].description`	Description of the project.
`data.projects[].human_id_prefix`	Prefix used for the project's human-readable identifier.
`page_info.page_size`	Number of items returned per page.
`page_info.total_count`	Total number of projects available.
`page_info.next`	URL to the next page of results, if any.
`page_info.prev`	URL to the previous page of results, if any.

Request

curl -X GET \
  'https://arcus.testsigma.com/api/v1/projects' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://arcus.testsigma.com/api/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://arcus.testsigma.com/api/v1/projects',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "message": "",
  "data": {
    "projects": [
      {
        "id": "18c50239-946d-428e-aa0c-260329f5c151",
        "created_at": 1709452800,
        "updated_at": 1712131200,
        "name": "Health Care Project",
        "description": "Regression suite for the patient portal",
        "human_id_prefix": "HCP"
      },
      {
        "id": "a91f3c2d-7b64-4e18-9f02-5c8a1d6e4b73",
        "created_at": 1707436800,
        "updated_at": 1710115200,
        "name": "Banking Platform",
        "description": "End-to-end tests for the core banking app",
        "human_id_prefix": "BNK"
      }
    ]
  },
  "page_info": {
    "page_size": 2,
    "total_count": 17,
    "next": "https://arcus.testsigma.com/api/v1/projects?page_size=2&page=2",
    "prev": ""
  }
}

Was this page helpful?