WA.cr APP - API v2
  1. Contacts
WA.cr APP - API v2
  • API v2 Documentation
    • Account
      • Get Account Info
      • Get Usage Statistics
      • Get Plan Limits
    • Authentication (OTP Verification)
      • Send OTP/Verification Code
      • Resend OTP
      • Verify OTP
      • Check OTP Status
      • List Authentication Templates
    • Comments
      • Get Comments
      • Add Comment
    • Contacts
      • List Contacts
        GET
      • Create Contact
        POST
      • Get Contact
        GET
      • Update Contact
        PATCH
      • Delete Contact
        DELETE
      • Batch Create Contacts
        POST
      • Batch Delete Contacts
        DELETE
    • Groups
      • List Groups
      • Create Group
      • Get Group
      • Update Group
      • Delete Group
      • Add Contacts to Group
      • Remove Contacts from Group
    • Messages
      • Send Text Message
      • Send Template Message
      • Send Media Message
      • Send Interactive Message
      • List Messages
      • Get Message
    • Sources
      • List Sources
      • Create Source
      • Get Source
      • Update Source
      • Delete Source
    • Statuses
      • List Statuses
      • Create Status
      • Get Status
      • Update Status
      • Delete Status
    • Templates
      • List Templates
      • Sync Templates from WhatsApp
      • Get Template
  1. Contacts

Get Contact

GET
/contacts/1
Retrieve a single contact by ID with optional relationship includes.

Authentication#

Required Scope: contacts:read

Path Parameters#

ParameterTypeDescription
idintegerRequired. The contact ID

Query Parameters#

ParameterTypeDescription
includestringComma-separated list of relationships to include
Allowed includes: groups, source, status

Response#

Success (200 OK): Returns the contact data wrapped in ContactResource format.

Response Fields#

FieldTypeDescription
idintegerContact ID
firstnamestringFirst name
lastnamestringLast name
companystring|nullCompany name
typestringContact type: lead, customer, guest
emailstring|nullEmail address
phonestring|nullPhone number
status_idintegerStatus ID
source_idintegerSource ID
descriptionstring|nullDescription
citystring|nullCity
statestring|nullState
zipstring|nullZIP/postal code
addressstring|nullStreet address
country_idinteger|nullCountry ID
assigned_idinteger|nullAssigned user ID
group_idarrayArray of group IDs
is_opted_outbooleanOpt-out status (default: false)
created_atstringISO 8601 datetime
updated_atstringISO 8601 datetime
groupsarrayGroups data (when include=groups). Each: { id, name, created_at, updated_at }
sourceobjectSource data (when include=source). Fields: { id, name, created_at, updated_at }
statusobjectStatus data (when include=status). Fields: { id, name, color, created_at, updated_at }

Error Responses#

StatusCodeDescription
404NOT_FOUNDContact not found
500INTERNAL_ERRORFailed to fetch contact

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

🟢200
application/json
Successful response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/contacts/1?include=groups,source,status' \
--header 'Authorization: Bearer <token>'
Response Response Example
{}
Modified at 2026-02-25 01:06:20
Previous
Create Contact
Next
Update Contact
Built with