Quick Start
Get up and running with the Arthix API in minutes. Generate an API Key and make your first authenticated request.
1. Register an Account
To use the API, you must first have an active account on the Arthix platform.
- Navigate to the main application UI.
- Click on Register and fill out your firm and admin details.
- Log into your new account.
2. Generate an API Key
API access requires a secure API Key, which acts as your authentication token.
- From the main dashboard, go to the Settings section in the sidebar.
- Navigate to the Api Key tab under Settings.
- Click Generate New API Key.
- Copy your generated key and store it securely. You will not be able to see it again!
Never share your API Key or commit it to a public repository. If your key is compromised, revoke it immediately from the dashboard.
3. Make Your First Request
Include your API Key in the X-Api-Key header and your Firm ID in the X-Firm-Id header of every request.
bash
curl -X POST https://api.arthix.ai/api/v1/contact/getall \
-H "X-Api-Key: a767f974809aa9980d1ad46af3e26a8" \
-H "X-Firm-Id: YOUR_FIRM_ID" \
-H "Content-Type: application/json" \
-d '{}'Successful Response
JSON
{
"isSuccess": true,
"data": [
{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"phone": "+1234567890"
}
],
"message": "Contacts retrieved successfully",
"error": null,
"errors": []
}