GET /api/companies.php
Header: X-API-Key: YOUR_API_KEY. Returns {"company": {...}} for the key-owning company. The selected fields are id, name, website, email, phone, plan, primary_color, and secondary_color.
Developer & API documentation
Current Integration Reference
Only the stable behavior visible in the current implementation is listed. Obtain a confirmed enterprise scope before depending on anything else.
Company-scoped server API
GET /api/employees.php
Header: X-API-Key: YOUR_API_KEY. Returns {"employees": [...]} for the key-owning company, ordered newest internal ID first. No public pagination or filtering parameters are implemented.
POST /api/employees.php
Headers: X-API-Key: YOUR_API_KEY and Content-Type: application/json. Body limit: 64 KB. Required strings: full_name and email. Optional strings: job_title, department, phone, phone_alt, landline, whatsapp, linkedin, website. The response is {"success":true,"id":123,"profile":"https://…"}.
Safe request example
POST /api/employees.php HTTP/1.1 X-API-Key: YOUR_API_KEY Content-Type: application/json Accept: application/json {"full_name":"Amina Hassan","email":"amina@example.com","job_title":"Sales Manager"}
Public read helpers
GET /api/v1/public-profile.php?slug=PUBLIC_SLUG
No credential. Returns a JSON public-profile representation only when the employee and company are publicly eligible. profile_id may be used instead of slug when it is an opaque public identifier.
GET /api/v1/vcard-link.php?slug=PUBLIC_SLUG
No credential. Returns {"ok":true,"vcard_url":"…"} for an eligible public card. This is a link helper; the vCard download itself is not a JSON integration endpoint.
Not represented as public API
Mobile card, profile, message, notification, Wallet and company-update routes are first-party application operations or incomplete/setup-dependent surfaces. They are intentionally excluded from this public integration contract. There is no documented bulk provisioning, delete/update employee API, SCIM API, or inbound webhook endpoint.
Continue reading
Control how employees represent your company externally
Explore the CardIQ platform or review the workflow from verification through identity deactivation.
See how CardIQ works View pricing