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"
          }
        ]
      }
    }
  }
}

This API returns the current settings for your project.

This API provides a snapshot to assist with operations, and the response structure may change without prior notice due to service updates.

Authentication header

ARGOS API uses the secret key in the x-api-key header for authentication. You can find your secret key in the dashboard project settings. When making API requests, include your API key in the x-api-key header as follows:

x-api-key: {yourAPIKey}

Request

Query parameters

string

You can check the current values of settings for a specific category.Filtering is possible by passing a comma-separated string. Additional categories will be added in the future.Possible values: managementExample: 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}'

Response

Success response

string

Unique identifier for the API request issued by ARGOS. Including the traceId in your inquiry will help you get a faster response.

object

Current project settings information.

Show Properties

object

Settings information related to project management.

Show management properties

object

Current status based on the submission control system. Returns inactive value when system operation is stopped.
“activateBlocking” won’t be affected by updates within the same version.

Show Properties

boolean

Whether the submission control system is activated.

string

The time when submission control was last activated (ISO8601).

array

Administrator information stored in the dashboard.

string

Project description set in the dashboard.

string

Return URL set in the dashboard.

object

Settings for options within the Return URL.

Show Properties

boolean

Whether to include custom field 1

boolean

Whether to include custom field 2

boolean

Whether to include custom field 3

boolean

Whether to include email

boolean

Whether to include KYC status

boolean

Whether to include submission ID

boolean

Whether to include user ID

boolean

Whether to skip the result page

boolean

Whether encryption is enabled

string

Stored terms of use URL.

object

IP list allowed for dashboard access and API.

Show Properties

array

IP list allowed for dashboard access

array

IP list allowed for API access

string

Configured project name.

string

Current operational status of the project. To change it, contact Customer Support (customersupport@argosidentity.com).Possible values:

open: A live production project.
test: A project for testing.
trial: A trial project. Up to 15 submissions per month; the count resets on the 1st of each month (UTC).
close: A closed project. Liveform submissions are rejected.

object

Webhook settings stored in the project.

Show Properties

string

Webhook registration time

string

URL to receive webhook

array

Webhook member list

Show member properties

string

Webhook member name

string

Time when webhook member was added (ISO8601)

string

Webhook member email

{
  "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"
          }
        ]
      }
    }
  }
}

Error response

Error codes

statusCode	code	message
400	BAD_REQUEST	Invalid query parameters
400	INVALID_CATEGORY	Invalid category parameter: [invalid categories]

{
  "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"
          }
        ]
      }
    }
  }
}

Overview

API Reference

Authentication header

Request

Query parameters

Response

Success response

Error response

​Authentication header

​Request

​Query parameters

​Response

​Success response

​Error response

Authentication header

Request

Query parameters

Response

Success response

Error response