Get Projects (Workspaces)

Retrieves the projects (formerly known as workspaces) for an account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Each project (or workspace) may be associated with a Harness organization and project, which are exposed through organizationIdentifier and projectIdentifier. You can use these filters instead of (or in addition to) the name query parameter when retrieving a workspace ID.

The result set of the API may be reduced based on the Project View Restrictions.

👍

Use this endpoint to get a workspace ID after migration to Harness

After migration to Harness, you can retrieve the workspace ID for a project by calling this endpoint and filtering results by organizationIdentifier and projectIdentifier.

Alternatively, filter by name using the Harness project name, not the Harness project ID. Your Split legacy API key will continue to work for this endpoint.

For detailed instructions, see the Retrieving a Workspace ID Using Harness Identifiers section in the Before and After: APIs for Split Admins Postman collection.


Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_ADMIN
  • API_WORKSPACE_ADMIN

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE*
  • ENVIRONMENT*

You can continue using your legacy Split Admin API key for this endpoint. To learn more about Admin API Key roles and scopes, see API keys overview.


Query Params
int32

The offset to retrieve. Useful for pagination.

int32
Defaults to 20

The maximum return limit per call is 1000.

string

Filter projects by name. This must be the project name and cannot be the project ID.

string
Defaults to IS

Match operator for the name query parameter. IS is the default value but STARTS_WITH and CONTAINS is also supported.

string

Filter projects by the Harness organization ID.

string

Filter projects by the Harness project ID.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain