Get Contact Request

Retrieve detailed information about a specific contact request by its ID.

🔹 Endpoint Details

GET /api/v1/contact-requests/{id}

🔒 Authentication

Header	Required	Description
Content-Type	Yes	Must be application/json
Authorization	Yes	Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📝 Path Parameters

Parameter	Type	Required	Description
id	string (UUID)	Yes	Unique identifier of the contact request

🧩 Request Example

curl -X GET "https://openapi.onlive.site/api/v1/contact-requests/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

📥 Response Format (HTTP 200)

See Contact Request Properties for the full entity schema.

Field	Type	Description
id	string (UUID)	Unique identifier
organizationId	string (UUID)	Owning organization
organizationName	string	Denormalized organization name
type	enum	contactmeback | keepmeinformed
status	enum	pending | accepted | rejected
preferredContact	enum	email | phone | whatsapp
name	string	Contact name
email	string	Contact email
phone	string	Contact phone
message	string	Free-form message
relatedService	string (UUID)	Related service ID
extraFields	object	Custom metadata
agentId	string (UUID)	Assigned agent
agentComment	string	Agent comment
userGroupId	string (UUID)	Assigned user group
userGroup	string	Denormalized user group name
taxonomies	array of strings	Taxonomy tags
externalId	string	External identifier
communicationLogs	array of objects	Audit trail of messages/calls
countCommunicationLogs	number	Communication log count
createdAt	string (ISO 8601)	Creation timestamp
updatedAt	string (ISO 8601)	Last update timestamp

Response Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "organizationName": "Acme Inc.",
  "type": "contactmeback",
  "status": "pending",
  "preferredContact": "email",
  "name": "John Doe",
  "email": "[email protected]",
  "phone": "+33612345678",
  "message": "Please send me a copy of the contract",
  "relatedService": "7a96c97a-bcf9-42df-984a-051c0fb8487e",
  "extraFields": {
    "department": "Sales",
    "location": "New York"
  },
  "agentId": "e4567-e89b-12d3-a456-426614174000",
  "agentComment": "Forwarded to sales team",
  "userGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "userGroup": "Sales Team",
  "taxonomies": ["/model/contact-request"],
  "externalId": "frm_abc123",
  "communicationLogs": [],
  "countCommunicationLogs": 0,
  "createdAt": "2025-05-13T15:00:00Z",
  "updatedAt": "2025-05-13T15:00:00Z"
}

❌ Error Responses

Status	Description
404	Contact request not found

This endpoint follows the standard error format.

📘 Notes

• The contact request must belong to your organization
• communicationLogs and countCommunicationLogs are server-managed

✅ Common Use Cases

• 🔍 Detail View: Open a single request in an agent dashboard
• 🔁 Sync: Refresh a local cache after a webhook
• 🧾 Audit: Fetch a request for compliance review