User Tools

Site Tools


api:deletedcustomer:list

API : Deleted Customer List

Introduction

This request returns deleted customers, newest deletion first.

Request

URL https://api.telecomx.dk/deletedcustomer
Method GET
Access level RESELLER_ADMIN or ADMIN
Query offset [optional] Index of the first customer to return, default 0.
limit [optional] Number of customers to return, default 50, min 1, max 200.
filter [optional] Text that must be found in the customer's name, phone, fax, e-mail address, CVR number, accounting system id or invoice e-mail address. Several words must all be found. Max. 100 characters.

Query example

https://api.telecomx.dk/deletedcustomer?filter=arka&offset=0&limit=50

Response

JSON object
offset Number Index of the first returned customer.
limit Number Number of customers asked for.
total Number Number of deleted customers matching the filter.
customers Array The customers, see below.
Customer object
_id Id Id of the customer.
name String Name of the customer.
vatNumber String CVR number, null if none.
accountingSystemId String Id of the customer in the accounting system, null if none.
phoneNumber String Phone number, null if none.
emailAddress String E-mail address, null if none.
isReseller Boolean True if the customer was a reseller.
parentReseller Object _id and name of the reseller the customer belonged to, null if none.
createdAt Date When the customer was created.
deletedAt Date When the customer was deleted.
deletedAtEstimated Boolean True when the customer was deleted before the change log started: deletedAt is then 2022-01-24, meaning “no later than”.

Example

{
  "offset": 0,
  "limit": 50,
  "total": 1,
  "customers": [
    {
      "_id": "619366605a8fe9d7495f1699",
      "name": "Northwind ApS",
      "vatNumber": "29178445",
      "accountingSystemId": "29178445",
      "phoneNumber": "+4596630006",
      "emailAddress": "info@example.dk",
      "isReseller": false,
      "parentReseller": { "_id": "52f4fd7734697b28ccaf77ec", "name": "PowerNet ApS" },
      "createdAt": "2021-11-16T08:12:00.000Z",
      "deletedAt": "2026-09-15T17:53:02.118Z",
      "deletedAtEstimated": false
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
422 limit Limit is out of range
500 internal_error <Unspecified>
api/deletedcustomer/list.txt · Last modified: by Telecom X AI

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki