SQL Server / Support API / List Deleted Users
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/deleted_users', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "deleted_users": [
-- {
-- "id": "<integer>",
-- "url": "<string>",
-- "name": "<string>",
-- "email": "<null>",
-- "created_at": "<string>",
-- "updated_at": "<string>",
-- "time_zone": "<string>",
-- "phone": "<string>",
-- "shared_phone_number": "<string>",
-- "photo": {},
-- "locale_id": "<integer>",
-- "locale": "<string>",
-- "organization_id": "<null>",
-- "role": "<string>",
-- "active": "<boolean>"
-- },
-- {
-- "id": "<integer>",
-- "url": "<string>",
-- "name": "<string>",
-- "email": "<null>",
-- "created_at": "<string>",
-- "updated_at": "<string>",
-- "time_zone": "<string>",
-- "phone": "<string>",
-- "shared_phone_number": "<string>",
-- "photo": {},
-- "locale_id": "<integer>",
-- "locale": "<string>",
-- "organization_id": "<null>",
-- "role": "<string>",
-- "active": "<boolean>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @time_zone nvarchar(4000)
DECLARE @phone nvarchar(4000)
DECLARE @shared_phone_number nvarchar(4000)
DECLARE @locale_id nvarchar(4000)
DECLARE @locale nvarchar(4000)
DECLARE @organization_id nvarchar(4000)
DECLARE @role nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'deleted_users'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'deleted_users[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'deleted_users[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'deleted_users[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'deleted_users[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'deleted_users[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'deleted_users[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @time_zone OUT, 'deleted_users[i].time_zone'
EXEC sp_OAMethod @jResp, 'StringOf', @phone OUT, 'deleted_users[i].phone'
EXEC sp_OAMethod @jResp, 'StringOf', @shared_phone_number OUT, 'deleted_users[i].shared_phone_number'
EXEC sp_OAMethod @jResp, 'StringOf', @locale_id OUT, 'deleted_users[i].locale_id'
EXEC sp_OAMethod @jResp, 'StringOf', @locale OUT, 'deleted_users[i].locale'
EXEC sp_OAMethod @jResp, 'StringOf', @organization_id OUT, 'deleted_users[i].organization_id'
EXEC sp_OAMethod @jResp, 'StringOf', @role OUT, 'deleted_users[i].role'
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'deleted_users[i].active'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/deleted_users
Postman Collection Item JSON
{
"name": "List Deleted Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
},
"description": "Returns deleted users, including permanently deleted users.\n\nIf the results contains permanently deleted users, the users' properties\nthat normally contain personal data, such as `email` and `phone`,\nare null. The `name` property is \"Permanently Deleted User\".\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"deleted_users\": [\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n }\n ]\n}"
}
]
}
