Get a Customer

Returns detailed information for a specific customer.

GET https://api.platica.mx/v1/clients/{id}

URL parameters

ParameterTypeDescriptionRequired
idstringEither the customer ID or their phone number in E.164 format without +

Response

{
  "workspaces": [
    {
      "id": "g6yCA16pkWl5eXo7KszB",
      "name": "ws_1",
      "clients": [
        {
          "id": "274fc73cb7d84a17955914fdc1a1f9d0",
          "phoneNumber": "524491255844",
          "name": "Juan Pérez",
          "firstname": "Juan",
          "lastname": "Pérez",
          "email": "juan.perez@email.com",
          "birthdate": null,
          "gender": "male",
          "company": null,
          "country": "MX",
          "state": "Jalisco",
          "city": "Guadalajara",
          "address": null,
          "postalCode": null,
          "status": "active",
          "moderation": {
            "totalStrikes": 0,
            "lastAction": null,
            "lastSource": null,
            "lastSeverity": null,
            "lastFlaggedAt": null,
            "lastCategories": [],
            "lastMatchedTerms": [],
            "blockedAt": null,
            "blockedBy": null,
            "blockedReason": null
          },
          "tags": [],
          "owners": ["user1@company.com", "user2@company.com"],
          "customFields": {
            "placas": "ABC123",
            "id_recepcion": "REC001",
            "fecha_siniestro": "2025-02-01"
          },
          "creationDate": "2025-02-06T16:45:50.146Z",
          "lastUpdate": "2025-02-06T16:45:50.146Z"
        }
      ],
      "clientsCount": 1
    }
  ]
}

Response fields

FieldDescription
idInternal customer ID
phoneNumberCustomer phone number without the + prefix
nameCustomer full name
firstnameCustomer first name
lastnameCustomer last name
emailEmail address
birthdateDate of birth
genderGender
companyCompany name
countryCountry of residence
stateState of residence
cityCity of residence
addressFull address
postalCodePostal code
statusCustomer status: active or blocked
moderationModeration history — see below
tagsTags associated with the customer
ownersList of responsible-user emails
customFieldsCustomer custom fields
creationDateCreation date in ISO 8601 format
lastUpdateLast update date in ISO 8601 format

The moderation object

Always returned in full: a customer with no incidents reports totalStrikes: 0 and every other field as null or empty.

FieldDescription
totalStrikesModeration strikes the customer has accumulated
lastActionAction taken on the last offence: warn, assist, or spam
lastSourceWhat detected it: lexicon, openai, llm_guardrail, or supervisor
lastSeveritySeverity of the last offence: low, medium, or high
lastFlaggedAtWhen the last offence was recorded, in ISO 8601
lastCategoriesCategories reported by the moderator
lastMatchedTermsTerms that triggered the detection
blockedAtWhen the customer was blocked, in ISO 8601. null while active
blockedByWho blocked them. null when the block was automatic
blockedReasonWhy they were blocked: guardrails_threshold_reached, manual_dashboard, conversation_spam, api_request, or the free-form reason you sent when blocking them