Skip to main content

Overview

Retrieves a contact record by its UUID. Use this to verify a contactId before creating a booking.

Endpoint

GET /partners/contacts/:contactId

Authentication

Requires a valid API Key with the partner_contacts_read permission.

Path Parameters

ParameterTypeRequiredDescription
contactIdUUIDYesThe contact ID returned from POST /partners/contacts

Example Request

curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/contacts/aaaaaaaa-0000-0000-0000-000000000001" \
  -H "x-api-key: YOUR_API_KEY"

Success Response

HTTP Status: 200 OK
{
  "success": true,
  "data": {
    "id": "aaaaaaaa-0000-0000-0000-000000000001",
    "name": "Ahmed Ali",
    "phone": "+966500000000",
    "isNewContact": false
  }
}

Error Responses

HTTP StatusCodeDescription
400VALIDATION_ERRORcontactId is not a valid UUID
401UNAUTHORIZEDInvalid or missing API key
403FORBIDDENMissing partner_contacts_read permission
404RESOURCE_NOT_FOUNDContact not found

  • POST /partners/contacts — Find or create a contact by phone