​
1. Endpoint

GET/Projection
GET https://rest-api.argosidentity.com/v3/projection/{projectionId}

​
2. Authentication

Include the API key in the x-api-key header:

x-api-key
x-api-key: {yourAPIKey}

​
3. Request Body

The request parameters should be sent as URL query parameters. Below are the parameter descriptions:

​
projectionId
string
required

The unique ID of a projection

​
4. Request Example

There is no requirement for a parameter name; projectionId only requires a value.

GET/Projection
curl --location 'https://rest-api.argosidentity.com/v3/projection/{projectionId}' \
--header 'x-api-key: {yourAPIKey}'

​
5. Response

​
5-1. Success Response

{
    "item": {
        "projection_id": "{projection_id}",
        "name": "{name}",
        "mode": "{mode}",
        "fields": [
            "gender",
            "nationality"
        ],
        "created_at": "2023-12-01T12:34:56.789Z"
    },
    "message": "Get projection success"
}

​
5-2. Response Field

Field NameDescriptionData TypeCategory
projection_idThe unique ID of the generated projectionStringProjection Info
nameThe projection nameStringProjection Info
modeThe projection mode. Currently, there is only the exclude option.StringProjection Info
fieldsThe list to exclude specific fields.Array<String>Projection Info
created_atCreated Time (Type of ISO 8601)StringProjection Info

​
5-3. Error Codes

Status CodeError MessageDescription
404Projection not foundWhen required fields (name, mode, fields) are missing in the request body
405Method not allowed for /projections/projectionId pathHTTP requests (PUT, DELETE, etc.) are not GET or POST.
500Internal server errorWhen the server encounters an unexpected exception error