API Explorer: /projects

To return a list of the projects, a workspaceId or an accountId is required. The sample code returns a list of projects within workspaceId of 123456. Use the actual ID value for the workspace to return the list of the projects in your workspace.

Projects List

curl 'https://a.blazemeter.com/api/v4/projects?workspaceId=123456' \
    --user 'api_key_id:api_key_secret'

Parameters

• accountId integer

  required

  The accountId you are wanting to get the list of projects from

• workspaceId integer

  required

  The workspaceId you are wanting to get the list of projects from

• name string

  Filters the returned project list to any project names that match the given string

Also see: Pagination and Sorting

See The Project Object for the details on the response attributes.

{
    "limit": 10,
    "skip": 0,
    "total": 2,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 234567,
            "name": "New Project",
            "userId": 234567,
            "description": "Tests using new project",
            "created": 1489672823,
            "updated": 1489672823,
            "workspaceId": 123456,
            "testsCount": 126
        },
        {
            "id": 123456,
            "name": "Default project",
            "userId": 123456,
            "description": null,
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 123456,
            "testsCount": 388
        }
    ],
    "request_id": "5dc9d8bd366b4"
}