Get Projects In Organization Using GET

List projects in org

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Admin	✔️	✔️
Organization Owner	✔️	✔️
Project Admin	✔️	✔️

Request

URI

GET

https://{api_host}/csp/gateway/resource/api/v1/orgs/{orgId}/projects

COPY

Path Parameters

string

orgId

Required

Parent organization ID for the project

Query Parameters

string

displayName

Optional

Name of the project

string

type

Optional

Type of the project

string

parentProjectId

Optional

If specified, the response will contain only projects that are direct subprojects of the project with the specified project id

string

enabledService

Optional

If specified, the response will contain only projects enabled for this service

string

serviceScope

Optional

If specified, the response will contain only projects allowed for this service

integer

pageStart

Optional

Constraints: minimum: 1 default: 1

pagination start, default 1

integer

pageLimit

Optional

Constraints: minimum: 1 maximum: 1000 default: 200

pagination limit, default 200, max 1000

string

orderByCreationDate

Optional

Order by creation date, default false

string

expandProject

Optional

If specified, the response will contain project subResourceServiceScopes and enabledServices, default false

string

vrn

Optional

If specified, the response will be filtered by vrn

Authentication

This operation uses the following authentication methods.

token

Responses

200

Returns PagedResponseProject of type(s) application/json

{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "createdBy": "string",
            "creationDate": "string",
            "depth": 0,
            "description": "string",
            "displayName": "string",
            "enabledServices": [
                "string"
            ],
            "id": "string",
            "lastModifiedBy": "string",
            "lastModifiedDate": "string",
            "leaf": false,
            "parentPath": "string",
            "parentProjectId": "string",
            "projectMetadata": {
                "metadataContents": {
                    "metadataContents": "string"
                },
                "metadataType": "string"
            },
            "subResourceServiceScopes": [
                "string"
            ],
            "type": "string",
            "vrn": "string"
        }
    ],
    "totalResults": 2000
}

string

nextLink

Optional

Relative path to next page if exists. Not returned for POST requests.

string

prevLink

Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

401

Unauthorized

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Not Found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

Internal Server Error

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/resource/api/v1/orgs/{orgId}/projects

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Project Management Operations

GET

Get Projects In Organization Using GET

POST

Create Project In Organization Using POST

GET

Get Soft Deleted Projects In Organization Using GET

GET

Get Project Metadata Keys Using GET

POST

Search Projects By Metadata Using POST

DELETE

Delete Project From Organization Using DELETE

GET

Get Projects Details Using GET

PATCH

Update Projects Attributes Using PATCH

GET

Get Enabled Services For Project Using GET

DELETE

Delete Project Metadata Using DELETE

GET

Get Project Metadata Using GET

PATCH

Update Project Metadata Using PATCH

PUT

Set Project Metadata Using PUT

GET

Get Parent Projects Using GET

GET

Get Project Service Scopes Using GET

POST

Add Project Service Scopes Using POST

POST

Create Project In Organization V2 Using POST