--- updatedAt: 2025-09-09T23:55:56.000Z agentTools: projectIndex: https://docs.ns-api.com/llms.txt --- # Read CDRs for Specific User # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "NetSapiens API v2", "description": "", "version": "1.0.0" }, "tags": [ { "name": "CDR (Call History)" } ], "paths": { "/domains/{domain}/users/{user}/cdrs": { "get": { "summary": " Read CDRs for Specific User", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "start", "in": "query", "description": "", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start" } }, { "name": "limit", "in": "query", "description": "", "required": false, "example": 1, "schema": { "$ref": "#/components/schemas/Limit" } }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "Off-net", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CdrU" } } } }, "headers": {}, "x-apidog-name": "OK" } }, "security": [ { "bearer": [] } ], "x-apidog-folder": "CDR (Call History)", "x-apidog-status": "released", "x-run-in-apidog": "https://apidog.com/web/project/374090/apis/api-4684007-run" } } }, "components": { "schemas": { "CdrU": { "type": "object", "properties": { "uid": { "type": "string" }, "domain": { "type": "string" }, "cdr_id": { "type": "string" }, "type": { "type": "integer" }, "time_start": { "type": "integer" }, "time_answer": { "type": "integer" }, "time_release": { "type": "integer" }, "duration": { "type": "integer" }, "orig_to_uri": { "type": "string" }, "number": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "onnet": { "type": "integer" }, "hide": { "type": "integer" }, "tag": { "type": "string" }, "expected_trace": { "type": "boolean" } }, "required": [ "uid", "domain", "cdr_id", "type", "time_start", "time_answer", "time_release", "duration", "orig_to_uri", "number", "name", "onnet", "hide", "tag", "expected_trace" ], "x-apidog-orders": [ "uid", "domain", "cdr_id", "type", "time_start", "time_answer", "time_release", "duration", "orig_to_uri", "number", "name", "onnet", "hide", "tag", "expected_trace" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "Schemas" }, "DomainNamePath": { "type": "string", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to \"~\" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain. ", "pattern": "^[A-Za-z0-9._-]*|~|\\*+", "maxLength": 64, "examples": [ "example.com", "myDomain", "test.12123" ], "default": "~", "x-apidog-folder": "Enums" }, "UserNamePath": { "type": "string", "description": "This is the main user extension for the user account. ~ can be used to mean \"my account\" which will extract the user from the token/key used for authentication. ", "examples": [ "1000", "200", "~" ], "minLength": 0, "maxLength": 16, "default": "~", "x-apidog-folder": "Enums" }, "DatetimeStart": { "type": "string", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. \n\nSupported formats include. \n* 2023-11-27 13:00:00\n* 2023-11-27T13:00:00Z\n* 2023-11-27T13:00:00-08:00\n* 2023-11-27T13:00:00-08:00[US/Pacific]\n* 2023-11-27T13:00:00Z[America/Phoenix]\n", "format": "rfc3339", "x-apidog-folder": "Enums" }, "DatetimeEnd": { "type": "string", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start. ", "format": "rfc3339", "x-apidog-folder": "Enums" }, "Limit": { "type": "number", "format": "int", "default": 100, "minimum": 1, "maximum": 1000, "description": "This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.", "x-apidog-folder": "Enums" }, "Start": { "type": "number", "format": "int", "default": 0, "minimum": 0, "description": "This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response.", "x-apidog-folder": "Enums" } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" }, "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://{server}/ns-api/v2", "description": "Dynamic Environment", "variables": { "server": { "default": "ns-api.com" } } } ], "security": [ { "bearerAuth": [] } ] } ```