Sign in
Case

List cases

List cases for the customer, optionally filtered by status, owner_type, owner_id, contact_id, and reference_id.

get/contact_cases

Query parameters

status'open' | 'closed'
Example:open

Filter by case status.

reference_idstring
Example:1fe1356f-3f7f-4ff9-9d33-08136b38f506

Filter to cases whose reference_id (the internal VoIPBin resource ID reference_type points at, e.g. a call ID) exactly matches this value.

owner_typestring
Example:agent

Filter by owner type.

owner_idstring uuid
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Filter by owner ID.

contact_idstring uuid
Example:b2c3d4e5-f6a7-8901-bcde-f12345678901

Filter to cases attributed to this Contact.

page_sizeinteger
Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

Successful response.

next_page_tokenstring

Pagination token for the next page. Empty when no further pages exist.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "peer": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "local": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "reference_type": "call",
      "reference_id": "1fe1356f-3f7f-4ff9-9d33-08136b38f506",
      "contact_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "owner_type": "agent",
      "owner_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
      "status": "open",
      "opened_at": "2026-06-01T09:30:00.000000Z",
      "closed_at": "2026-06-02T09:30:00.000000Z",
      "closed_reason": "agent_closed",
      "closed_by_type": "agent",
      "closed_by_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
      "name": "Billing dispute follow-up",
      "detail": "Customer disputes March invoice charges.",
      "previous_case_id": "11111111-0000-0000-0000-000000000001",
      "tm_create": "2026-06-01T09:30:00.000000Z",
      "tm_update": "2026-06-01T09:30:00.000000Z"
    }
  ],
  "next_page_token": "2026-06-01T09:30:01.000000Z"
}

Changes

Changed in 7 of the 54 revisions of this API.148

  • d5569b3154112See the full diff
    • ●

      added the new web_session enum value to the result/items/local/allOf[CommonAddress]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new web_session enum value to the result/items/peer/allOf[CommonAddress]/type response property for the response status 200

      response-property-enum-value-added

  • 3ab6b73994fc2See the full diff
    • ○

      added the new optional query request parameter reference_id

      new-optional-request-parameter

    • ○

      added the optional property result/items/reference_id to the response with the 200 status

      response-optional-property-added

  • 6bba44d87e8322See the full diff
    • ●

      removed the optional property result/items/peer_target from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property result/items/peer_type from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property result/items/local to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property result/items/peer to the response with the 200 status

      response-optional-property-added

  • 0f1b4632fdbc2See the full diff
    • ○

      added the optional property result/items/detail to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property result/items/name to the response with the 200 status

      response-optional-property-added

  • 1712341611071See the full diff
    • ○

      added the new optional query request parameter contact_id

      new-optional-request-parameter

  • 0e81fffc28491See the full diff
    • ○

      endpoint added

      endpoint-added

  • 995c56ba92191See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog