Skip to main content
GET
/
v2.0
/
profiles
/
schema
/
{projectId}
Get Schema
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/profiles/schema/{projectId} \
  --header 'X-API-Key: <api-key>'
{
  "profile": {
    "prevent_data_collection": true,
    "accepted_gdpr": true,
    "privacy_policy": {},
    "tasks": [
      "buyer"
    ],
    "memories": [
      {
        "id": "123456",
        "timestamp": "2024-09-23T08:37:00Z",
        "text": "This is a memory."
      }
    ],
    "firstname": "Max",
    "lastname": "Mustermann",
    "email": "jsmith@example.com",
    "profilepic": ""
  },
  "active": true,
  "contactIds": [
    "mail@example.com"
  ]
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
projectId
string
required
Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns Profile schema object.

​
profile
object
​
active
boolean
​
contactIds
string[]
Last modified on June 11, 2026