Get project

Prev Next

Available in Classic and VPC

Get the details of the project.

Request

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

Method URI
GET /common/v2/projects/{projectId}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Project ID

Request example

The request example is as follows:

curl --location --request GET 'https://sens.apigw.ntruss.com/common/v2/projects/5c7c325a-****-****-****-42ef00c15265' \
--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": "5c7c325a-****-****-****-42ef00c15265",
    "projectName": "sens",
    "projectDesc": "sample project",
    "useSms": true,
    "useKkoBizMsg": true,
    "smsService": {
        "serviceId": "ncp:sms:kr:50********51: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*********3:sens",
        "serviceName": "sens",
        "createTime": "2025-11-18T09:14:49.691",
        "updateTime": "2025-11-18T09:14:49.690"
    },
    "createTime": "2025-11-18T09:14:49.679"
}