List step groups

GET/projects/{project_id}/step_groups

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

Retrieves a paginated list of step groups for a project.

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

Path parameters

project_id Unique identifier of the project whose step groups are listed.

Query parameters

page_size Number of step groups to return per page.

Response attributes

`message`	Status message for the request; may be empty.
`data.step_groups[].id`	Unique identifier of the step group.
`data.step_groups[].title`	Title of the step group.
`data.step_groups[].description`	Description of the step group.
`data.step_groups[].human_id`	Human-readable identifier for the step group.
`data.step_groups[].project_id`	Identifier of the project the step group belongs to.
`data.step_groups[].created_at`	Unix timestamp of when the step group was created.
`data.step_groups[].updated_at`	Unix timestamp of the last update to the step group.
`page_info.page_size`	Number of items returned per page.
`page_info.total_count`	Total number of step groups available for the project.
`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/{project_id}/step_groups' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/step_groups', {
  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/{project_id}/step_groups',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "message": "",
  "data": {
    "step_groups": [
      {
        "id": "b3d9f1a2-6c84-4e57-9a01-2f7c5d8e1b40",
        "title": "Regression Test Step Group - 5",
        "description": "Step group for regression test cases",
        "human_id": "DEMO-SG-1",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "created_at": 1710675200,
        "updated_at": 1710675200
      },
      {
        "id": "e5f6a7b8-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
        "title": "Smoke Test Step Group - 2",
        "description": "Step group for smoke test cases",
        "human_id": "DEMO-SG-2",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "created_at": 1709452800,
        "updated_at": 1712131200
      }
    ]
  },
  "page_info": {
    "page_size": 2,
    "total_count": 9,
    "next": "https://arcus.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups?page_size=2&page=2",
    "prev": ""
  }
}

Was this page helpful?