Skip to main content

List customer service records

GET 

/customer_service_records

List customer service records.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    sort[] string

    Possible values: [created_at, -created_at]

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

    filter[phone_number][eq] string

    Filters records to those with a specified number.

    filter[phone_number][in][] string[]

    Filters records to those with at least one number in the list.

    filter[status][eq] string

    Possible values: [pending, completed, failed]

    Filters records to those with a specific status.

    filter[status][in][] string[]

    Possible values: [pending, completed, failed]

    Filters records to those with a least one status in the list.

    filter[created_at][lt] date-time

    Filters records to those created before a specific date.

    filter[created_at][lt] date-time

    Filters records to those created after a specific date.

Responses

200: Successful Response

Schema

    data

    object[]

  • Array [

  • id uuid

    Uniquely identifies this customer service record

    phone_number string

    The phone number of the customer service record.

    status string

    Possible values: [pending, completed, failed]

    The status of the customer service record

    error_message string

    The error message in case status is failed. This field would be null in case of pending or completed status.

    result

    object

    The result of the CSR request. This field would be null in case of pending or failed status.

    carrier_name string

    The name of the carrier that the customer service record is for.

    associated_phone_numbers string[]

    The associated phone numbers of the customer service record.

    admin

    object

    The admin of the customer service record.

    name string

    The name of the customer service record.

    billing_phone_number string

    The billing phone number of the customer service record.

    account_number string

    The account number of the customer service record.

    authorized_person_name string

    The authorized person name of the customer service record.

    address

    object

    The address of the customer service record

    administrative_area string

    The state of the address

    locality string

    The city of the address

    postal_code string

    The zip code of the address

    street_address string

    The street address

    full_address string

    The full address

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was created.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: The required authentication headers were either invalid or not included in the request.

Schema

    errors object[]

403: You do not have permission to perform the requested action on the specified resource or resources.

Schema

    errors object[]

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors object[]

500: An unexpected error occurred.

Schema

    errors object[]
Loading...