Skip to main content
GET
/
v2.0
/
profiles
/
{profileId}
Get a Profile
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/profiles/{profileId} \
  --header 'Authorization: Bearer <token>' \
  --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"
  ],
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

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

Path Parameters

​
profileId
string
required

The Id of the Profile

Required string length: 24

Response

Returns Profile Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
profile
object
​
active
boolean
​
contactIds
string[]
​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24
⌘I