v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Customer Service Record

List customer service records

List customer service records.

get/customer_service_records

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Consolidated filter parameter (deepObject style). Originally: filter[phone_number][eq], filter[phone_number][in][], filter[status][eq], filter[status][in][], filter[created_at][lt], filter[created_at][gt]

{
  "created_at": {
    "gt": "2020-01-01T00:00:00Z",
    "lt": "2020-01-01T00:00:00Z"
  },
  "phone_number": {
    "eq": "+12441239999",
    "in": [
      "+12441239999"
    ]
  },
  "status": {
    "eq": "pending",
    "in": [
      "pending"
    ]
  }
}

value'created_at' | '-created_at'

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Consolidated sort parameter (deepObject style). Originally: sort[value]

{
  "value": "created_at"
}

Response

Successful Response

Example response

{
  "data": [
    {
      "created_at": "2021-03-19T10:07:15.527Z",
      "error_message": "CSR information not available.",
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "phone_number": "+12065551212",
      "record_type": "customer_service_record",
      "result": {
        "address": {
          "administrative_area": "NY",
          "full_address": "123 Main St; New York; NY; 10001",
          "locality": "New York",
          "postal_code": "10001",
          "street_address": "123 Main St"
        },
        "admin": {
          "account_number": "1234567890",
          "authorized_person_name": "John Doe",
          "billing_phone_number": "+12065551212",
          "name": "John Doe"
        },
        "associated_phone_numbers": [
          "+12065551212"
        ],
        "carrier_name": "ABC CARRIER, INC."
      },
      "status": "completed",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "webhook_url": "https://example.com/webhook"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}