Cubu Docs
S2S API Guide
S2S API Guide
  • About Cubu Server-to-Server API
  • Accessing the API
  • Agent Impersonation API
    • Call Again
    • Clock-in
    • Clock-out
    • Get Agent Status
    • List Active Cases
    • List Inboxes
    • List Workspaces
    • List Workstations
    • Occupy a Workstation
    • Resolve a Case
    • Select Current Unit
    • Start Processing the Next Case
    • Change Status to Available
    • Change Status to Unavailable
    • Vacate a Workstation
  • Appointments Management API
    • Book Appointment
    • Cancel Appointment
    • List Appointments in Calendar
    • List Calendars of a Service
    • List Vacancies in a Calendar
  • Case Management API
    • Queue Up
  • Customer Management API
    • Create a Customer Record
    • Get Customer Record
    • Update a Customer Record
    • Find a Customer Record
  • Organization API
    • List Back-office tasks
    • List Users
Powered by GitBook
On this page
  • URL
  • Headers
  • Response
  1. Customer Management API

Get Customer Record

Returns the specified customer record.

This endpoint requires the Customers Manager role.

URL

GET: https://[base-url]/{applicationId}/customers/{customerRecordId}

Headers

Authorization: Bearer <accessToken>

Response

Success -> 200

Sample response:

{
    "recordId": "9cf609f4-bdb8-48b6-9215-0692d33e0c9e",
    "dataTableId": "8ab4307c-5f1c-4537-b0d5-718aeea9d2f4",
    "displayName": "Tim Allen",
    "dateCreated": "2022-11-28T13:22:16.758766Z",
    "dateUpdated": "2023-07-07T06:15:17.775647Z",
    "isBuiltIn": true,
    "itemNameSingular": "Customer",
    "fields": [
        {
            "fieldTypeId": "8f7db960-d071-47ec-8299-3d56b1b2e45e",
            "dataType": "Text",
            "fieldName": "First Name",
            "hintText": null,
            "slug": "customer-first-name",
            "isKey": false,
            "isRequired": false,
            "settings": null,
            "value": "<field value>",
            "displayValue": "<display value>",
            "isEmpty": true,
            "isRestricted": false,
            "accessLevel": "Write",
            "colorCode": null,
            "position": 1
        },
        {...}
    ]
}
PreviousCreate a Customer RecordNextUpdate a Customer Record

Last updated 8 months ago