GET/Projects

curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

curl -X GET 'https://kr.rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

{
  "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
  "item": {
    "management": {
      "activateBlocking": {
        "activate": false
      },
      "admins": [
        "test@argosidentity.com"
      ],
      "description": " ",
      "formPrivacyPolicyUrl": " ",
      "formReturnUrl": " ",
      "formReturnUrlConfig": {
        "cf1": false,
        "cf2": false,
        "cf3": false,
        "email": false,
        "kycStatus": false,
        "submissionId": false,
        "userId": false,
        "skipResultPage": false,
        "isEncrypted": false
      },
      "formTermsOfUseUrl": " ",
      "ipWhitelist": {
        "admin": [],
        "api": []
      },
      "name": "test-project",
      "projectStatus": "open",
      "webhook": {
        "createTime": "2025-05-07T09:07:28.775Z",
        "url": "https://test.argosidentity.com",
        "members": [
          {
            "name": "test-member",
            "addDate": "2025-06-10T01:35:07.053Z",
            "email": "test@argosidentity.com"
          }
        ]
      }
    }
  }
}

현재 프로젝트의 설정 값을 응답하는 API입니다.

해당 API는 운영이 도움을 주기 위한 스냅값이므로 서비스 업데이트에 따라서 응답 구조가 사전 공지 없이 변경될 수 있습니다.

인증 헤더

아르고스 API는 x-api-key 헤더의 시크릿 키를 이용해 인증을 수행합니다. 시크릿 키는 대시보드 프로젝트 설정에서 확인할 수 있습니다. API 요청시 다음과 같이 x-api-key 헤더에 API 키를 포함시켜야 합니다:

x-api-key: {yourAPIKey}

요청

Query 파라미터

string

특정 카테고리에 해당하는 설정의 현재 값을 확인할 수 있습니다.,로 구분된 문자열을 전달하여 필터링이 가능합니다. 추후 카테고리가 추가될 예정입니다.가능한 값: management예시: category=management

curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

curl -X GET 'https://kr.rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

응답

성공 응답

string

아르고스에서 발급하는 API 요청의 고유 식별자입니다. 문의시 traceId를 첨부하면 더 빠르게 답변을 받을 수 있습니다.

object

현재 프로젝트의 설정 정보입니다.

표시 item

object

프로젝트 관리에 해당하는 설정 정보입니다.

표시 management item

object

제출제어 시스템에 따른 현재 상태값입니다. 시스템운영이 중단 시 비활성 값을 응답합니다.
“activateBlocking”은 동일 버전 내 업데이트의 영향을 받지 않습니다.

표시 item

boolean

제출제어 시스템의 활성화 유무입니다.

string

마지막으로 제출제어가 활성화된 시각(ISO8601)입니다.

array

대시보드에 저장된 관리자 정보입니다.

string

대시보드에서 설정한 프로젝트에 대한 description입니다.

string

대시보드에서 설정한 개인정보처리방침 URL입니다.

string

대시보드에서 설정한 Return URL입니다.

object

Return URL 내에서 옵션에 대한 설정 값을 응답합니다.

표시 item

boolean

커스텀 필드 1 포함 여부

boolean

커스텀 필드 2 포함 여부

boolean

커스텀 필드 3 포함 여부

boolean

이메일 포함 여부

boolean

KYC 상태 포함 여부

boolean

제출 ID 포함 여부

boolean

사용자 ID 포함 여부

boolean

결과 페이지 건너뛰기 여부

boolean

암호화 여부

string

저장된 이용약관 URL입니다.

object

대시보드 접근 및 API에 허용된 IP LIST를 응답합니다.

표시 item

array

대시보드 접근 허용 IP LIST

array

API 접근 허용 IP LIST

string

설정된 프로젝트의 이름입니다.

string

현재 프로젝트의 운영 상태입니다. 변경을 원하실 때는 ARGOS 관리자에게 문의해주세요.가능한 값:

open: 운영 중인 정식 프로젝트입니다.
test: 테스트용 프로젝트입니다.
trial: 체험 프로젝트입니다. 월 15회까지 제출할 수 있으며 매월 1일(UTC) 초기화됩니다.
close: 종료된 프로젝트입니다. LiveForm 제출이 거절됩니다.

object

프로젝트내에 저장된 웹훅 설정값을 응답합니다.

표시 item

string

웹훅 등록 시각

string

웹훅을 수신할 주소

array

웹훅 멤버 목록

표시 member item

string

웹훅 멤버 이름

string

웹훅 멤버가 추가된 시각 (ISO8601)

string

웹훅 멤버 이메일

{
  "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
  "item": {
    "management": {
      "activateBlocking": {
        "activate": false
      },
      "admins": [
        "test@argosidentity.com"
      ],
      "description": " ",
      "formPrivacyPolicyUrl": " ",
      "formReturnUrl": " ",
      "formReturnUrlConfig": {
        "cf1": false,
        "cf2": false,
        "cf3": false,
        "email": false,
        "kycStatus": false,
        "submissionId": false,
        "userId": false,
        "skipResultPage": false,
        "isEncrypted": false
      },
      "formTermsOfUseUrl": " ",
      "ipWhitelist": {
        "admin": [],
        "api": []
      },
      "name": "test-project",
      "projectStatus": "open",
      "webhook": {
        "createTime": "2025-05-07T09:07:28.775Z",
        "url": "https://test.argosidentity.com",
        "members": [
          {
            "name": "test-member",
            "addDate": "2025-06-10T01:35:07.053Z",
            "email": "test@argosidentity.com"
          }
        ]
      }
    }
  }
}

실패 응답

오류 코드

statusCode	code	message
400	BAD_REQUEST	Invalid query parameters
400	INVALID_CATEGORY	Invalid category parameter: [잘못된 카테고리들]

{
  "traceId": "018f1234-5678-90ab-cdef-123456789abc",
  "code": "BAD_REQUEST",
  "message": "Invalid query parameters"
}

⌘I

curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

curl -X GET 'https://kr.rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

{
  "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
  "item": {
    "management": {
      "activateBlocking": {
        "activate": false
      },
      "admins": [
        "test@argosidentity.com"
      ],
      "description": " ",
      "formPrivacyPolicyUrl": " ",
      "formReturnUrl": " ",
      "formReturnUrlConfig": {
        "cf1": false,
        "cf2": false,
        "cf3": false,
        "email": false,
        "kycStatus": false,
        "submissionId": false,
        "userId": false,
        "skipResultPage": false,
        "isEncrypted": false
      },
      "formTermsOfUseUrl": " ",
      "ipWhitelist": {
        "admin": [],
        "api": []
      },
      "name": "test-project",
      "projectStatus": "open",
      "webhook": {
        "createTime": "2025-05-07T09:07:28.775Z",
        "url": "https://test.argosidentity.com",
        "members": [
          {
            "name": "test-member",
            "addDate": "2025-06-10T01:35:07.053Z",
            "email": "test@argosidentity.com"
          }
        ]
      }
    }
  }
}

개요

API 참조

인증 헤더

요청

Query 파라미터

응답

성공 응답

실패 응답

​인증 헤더

​요청

​Query 파라미터

​응답

​성공 응답

​실패 응답

인증 헤더

요청

Query 파라미터

응답

성공 응답

실패 응답