Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cariqa.mintlify.app/llms.txt

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

​
User Creation and Management Flow

All user-related operations require users to be created first in the system.

​
Create User

curl -X POST "https://connect.cariqa.com/api/v1/users/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "locale": "de",
    "custom_properties": {
        "external_id": "abcdefg123456"
    }
  }'
Response: 
{
  "id": "72794486-bf87-44fb-9b74-5b8fed6c994d",
  "email": "user@example.com",
  "locale": "de",
  "external_id": {
    "external_id": "abcdefg123456"
  }
}

​
List Users Before Selection

curl -X GET "https://connect.cariqa.com/api/v1/users/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
Response: 
{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "29b8c323-eaf8-487a-a43d-0d37dd7328f1",
      "email": "user1@example.com",
      "locale": "en",
      "custom_properties": null
    },
    {
      "id": "72794486-bf87-44fb-9b74-5b8fed6c994d",
      "email": "user@example.com",
      "locale": "de",
      "custom_properties": {
        "external_id": "abcdefg123456"
      }
    },
    {
      "id": "db48d284-d67b-4e71-9065-1ef0e1b062d0",
      "email": "user@example.com",
      "locale": "de",
      "custom_properties": {
        "external_id": null
      }
    }
  ]
}

​
Retrieve User Details

curl -X GET "https://connect.cariqa.com/api/v1/users/72794486-bf87-44fb-9b74-5b8fed6c994d/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "en"
  }'
Response: 
{
  "id": "72794486-bf87-44fb-9b74-5b8fed6c994d",
  "email": "user@example.com",
  "locale": "de",
  "custom_properties": {
    "external_id": "abcdefg123456"
  }
}

​
Update User Details

curl -X PATCH "https://connect.cariqa.com/api/v1/users/72794486-bf87-44fb-9b74-5b8fed6c994d/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "en"
  }'
Response: 
{
  "id": "72794486-bf87-44fb-9b74-5b8fed6c994d",
  "email": "user@example.com",
  "locale": "en",
  "custom_properties": {
    "external_id": "abcdefg123456"
  }
}

​
Soft Delete User

curl -X DELETE "https://connect.cariqa.com/api/v1/users/72794486-bf87-44fb-9b74-5b8fed6c994d/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

​
Key Implementation Notes

  • Client Scoping: API automatically validates ownership - users are scoped to the authenticated client
  • Email Uniqueness: Email addresses are not unique across the system and are optional
  • External id: Set external ids of the users and use them to search users
  • Soft Delete: Users are marked as deleted but data is preserved for compliance
  • Automatic Validation: No need to manually verify user ownership before calling detail endpoints