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.
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:
Request Query parameters 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}' Response Success response Unique identifier for the API request issued by ARGOS. Including the traceId in your inquiry will help you get a faster response.
Current project settings information. Settings information related to project management. Show management properties
Current status based on the submission control system. Returns inactive value when system operation is stopped. Whether the submission control system is activated.
The time when submission control was last activated (ISO8601).
Administrator information stored in the dashboard.
Project description set in the dashboard.
Privacy policy URL set in the dashboard.
Return URL set in the dashboard.
Settings for options within the Return URL. Whether to include custom field 1
Whether to include custom field 2
Whether to include custom field 3
Whether to include KYC status
Whether to include submission ID
Whether to include user ID
Whether to skip the result page
Whether encryption is enabled
IP list allowed for dashboard access and API. IP list allowed for dashboard access
IP list allowed for API access
Current operational status of the project. Please contact ARGOS administrator if you want to change it. Possible values: Trial, Test, Service, Closed
Webhook settings stored in the project. Webhook registration time
Webhook member list Time when webhook member was added (ISO8601)
{ "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" } 
