Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
category
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}'

​
Response

​
Success response

​
traceId
string
Unique identifier for the API request issued by ARGOS. Including the traceId in your inquiry will help you get a faster response.
​
item
object
Current project settings information.
{
  "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
statusCodecodemessage
400BAD_REQUESTInvalid query parameters
400INVALID_CATEGORYInvalid category parameter: [invalid categories]
 
{
  "traceId": "018f1234-5678-90ab-cdef-123456789abc",
  "code": "BAD_REQUEST",
  "message": "Invalid query parameters"
}