Get project list

Available in Classic and VPC

Get project list.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/common/v2/projects

Request headers

For information about the headers common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`projectName`	String	Optional	Project name Filter values that match in whole or in part.
`pageSize`	Integer	Optional	Number of items per page 1-100 (default: 100)
`pageIndex`	Integer	Optional	Page index 0-N (default: 0)

Request example

The request example is as follows:

curl --location --request GET 'https://sens.apigw.ntruss.com/common/v2/projects' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`projectId`	String	Required	Project ID
`projectName`	String	Required	Project name
`projectDesc`	String	Required	Project description
`useSms`	Boolean	Required	SMS service usage `true` \| `false` `true`: Enable `false`: Disable
`useKkoBizMsg`	Boolean	Required	Biz Message service usage `true` \| `false` `true`: Enable `false`: Disable
`smsService`	Object	Optional	SMS service meta information
`smsService.serviceId`	String	Required	SMS service ID
`smsService.serviceName`	String	Required	SMS service name
`smsService.createTime`	String	Required	SMS service creation date and time YYYY-MM-DDTHH:mm:ss.sss format
`smsService.updateTime`	String	Optional	SMS service modification date and time YYYY-MM-DDTHH:mm:ss.sss format
`smsService.useBlockService`	Boolean	Required	080 call block number service usage `true` \| `false` `true`: Enable `false`: Disable
`kkoBizMsgService`	Object	Optional	Biz Message service meta information
`kkoBizMsgService.serviceId`	String	Required	Biz Message service ID
`kkoBizMsgService.serviceName`	String	Required	Biz Message service name
`kkoBizMsgService.createTime`	String	Required	Biz Message service creation date and time YYYY-MM-DDTHH:mm:ss.sss format
`kkoBizMsgService.updateTime`	String	Optional	Biz Message service modification date and time YYYY-MM-DDTHH:mm:ss.sss format
`createTime`	String	Required	Project creation date and time YYYY-MM-DDTHH:mm:ss.sss format
`updateTime`	String	Optional	Project final modification date and time YYYY-MM-DDTHH:mm:ss.sss format Not displayed if there is no modification history

Response status codes

For information about the HTTP status codes common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service response status codes.

Response example

The response example is as follows:

[
    {
        "projectId": "c665f4dc-****-****-****-b1c7880a9b4a",
        "projectName": "mypush",
        "projectDesc": "push service",
        "useSms": false,
        "useKkoBizMsg": true,
        "smsService": {
            "serviceId": "ncp:sms:kr:50********10:mypush",
            "serviceName": "mypush",
            "createTime": "2025-11-18T10:21:53.540",
            "updateTime": "2025-11-18T10:21:53.537",
            "useBlockService": false
        },
        "kkoBizMsgService": {
            "serviceId": "ncp:kkobizmsg:kr:50********25:mypush",
            "serviceName": "mypush",
            "createTime": "2025-11-18T10:21:53.546",
            "updateTime": "2025-11-18T10:21:53.544"
        },
        "createTime": "2025-11-18T10:21:53.536"
    },
    {
        "projectId": "5c7c325a-****-****-****-42ef00c15265",
        "projectName": "sens",
        "projectDesc": "sample project",
        "useSms": true,
        "useKkoBizMsg": true,
        "smsService": {
            "serviceId": "ncp:sms:kr:50*********1:sens",
            "serviceName": "sens",
            "createTime": "2025-11-18T09:14:49.686",
            "updateTime": "2025-11-18T09:14:49.681",
            "useBlockService": true
        },
        "kkoBizMsgService": {
            "serviceId": "ncp:kkobizmsg:kr:50*********5:sens",
            "serviceName": "sens",
            "createTime": "2025-11-18T09:14:49.691",
            "updateTime": "2025-11-18T09:14:49.690"
        },
        "createTime": "2025-11-18T09:14:49.679"
    }
]