Skip to main content
GET
/
contact
Get Contact
curl --request GET \
  --url https://api.flowiq.live/contact \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "contact": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "full_name": "John Doe",
    "whatsapp_id": "27123456789",
    "phone_number": "+27123456789",
    "email": "john@example.com",
    "tags": [
      "customer",
      "premium"
    ],
    "organization_id": "org-uuid-here",
    "bot_status": "active",
    "allow_broadcast": true,
    "archived": false,
    "blocked": false,
    "active_status": false,
    "has_unread_messages": false,
    "source": {
      "type": "api",
      "location": {},
      "created_at": "2025-12-11T10:30:00Z"
    },
    "contact_summary": null,
    "contact_summary_updated_at": null,
    "created_at": "2025-12-11T10:30:00Z",
    "updated_at": "2025-12-11T10:30:00Z"
  }
}

​
Basic Usage

curl -X GET "https://api.flowiq.live/contact?tenantId=your-org&phone_number=27123456789" \
  -H "Authorization: Bearer fiq_YOUR_API_KEY"

​
Query Parameters

ParameterTypeRequiredDescription
tenantIdstringYesYour organization’s tenant slug
phone_numberstringYes*Phone number with country code
whatsapp_idstringYes*Normalized digits-only phone number
*Provide either phone_number or whatsapp_id — both formats are accepted.

​
Response

​
Success (200)

{
  "success": true,
  "contact": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "full_name": "John Doe",
    "whatsapp_id": "27123456789",
    "phone_number": "+27123456789",
    "email": "john@example.com",
    "tags": ["customer", "premium"],
    "organization_id": "org-uuid-here",
    "bot_status": "active",
    "allow_broadcast": true,
    "archived": false,
    "blocked": false,
    "active_status": false,
    "has_unread_messages": false,
    "source": { "type": "api" },
    "contact_summary": null,
    "contact_summary_updated_at": null,
    "created_at": "2025-12-11T10:30:00Z",
    "updated_at": "2025-12-11T10:30:00Z"
  }
}

​
Error: Contact Not Found (404)

{
  "error": "Contact not found",
  "message": "No contact found with phone number 27123456789"
}

​
Integration Example

async function getContact(apiKey, tenantId, phoneNumber) {
  const url = new URL("https://api.flowiq.live/contact");
  url.searchParams.set("tenantId", tenantId);
  url.searchParams.set("phone_number", phoneNumber);

  const response = await fetch(url.toString(), {
    headers: { Authorization: `Bearer ${apiKey}` },
  });

  const data = await response.json();
  if (!response.ok) throw new Error(data.message);
  return data.contact;
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN

Query Parameters

​
tenantId
string
required

Organization tenant identifier (slug)

​
phone_number
string

Recipient phone number with country code (use this or whatsapp_id)

​
whatsapp_id
string

WhatsApp ID (normalized phone number, digits only)

Response

Contact found

​
success
boolean
Example:

true

​
contact
object