Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Contact Profiles

Get Schema

Gets the Contact Profile schema.

get/v2.0/profiles/schema/{projectId}

Path parameters

projectIdstring required

The unique identifier for the Project.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Response

Returns Profile schema object.

activeboolean
contactIdsstring[]

Example response

{
  "profile": {
    "tasks": [
      "buyer"
    ],
    "memories": [
      {
        "id": "123456",
        "timestamp": "2024-09-23T08:37:00Z",
        "text": "This is a memory."
      }
    ],
    "firstname": "Max",
    "lastname": "Mustermann"
  },
  "contactIds": [
    "mail@example.com"
  ]
}