Objective-C / Support API / List Workspaces
Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://example.zendesk.com/api/v2/workspaces" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "workspaces": [
// {
// "activated": "<boolean>",
// "apps": [
// {
// "ut_1": true
// },
// {
// "Lorem_ec": "ut ipsum nulla voluptate",
// "sed_a": 38535010.16636646
// }
// ],
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "macro_ids": [
// "<integer>",
// "<integer>"
// ],
// "macros": [
// "<integer>",
// "<integer>"
// ],
// "position": "<integer>",
// "prefer_workspace_app_order": "<boolean>",
// "selected_macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "elit_0": 95926683,
// "Loreme7": 1915356
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "ut_2": true,
// "exf9": false,
// "magna_5": false
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "ticket_form_id": "<integer>",
// "title": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "activated": "<boolean>",
// "apps": [
// {
// "laborum_": "esse elit mollit nulla",
// "dolore_72": 44930495
// },
// {
// "Duis_e27": false,
// "do_7b": true,
// "eu_6": true
// }
// ],
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "macro_ids": [
// "<integer>",
// "<integer>"
// ],
// "macros": [
// "<integer>",
// "<integer>"
// ],
// "position": "<integer>",
// "prefer_workspace_app_order": "<boolean>",
// "selected_macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "nostrud_7": false,
// "ex69c": -43731952,
// "ut_a": "anim nostrud pariatur",
// "mollit__": -87941840
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "deseruntc_": false,
// "consequatd0": 17786909,
// "id_4a": false
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "ticket_form_id": "<integer>",
// "title": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *activated = 0;
NSString *created_at = 0;
NSString *description = 0;
NSString *id = 0;
NSString *position = 0;
NSString *prefer_workspace_app_order = 0;
NSString *ticket_form_id = 0;
NSString *title = 0;
NSString *updated_at = 0;
NSString *url = 0;
int j;
int count_j;
BOOL ut_1;
NSString *Lorem_ec = 0;
NSString *sed_a = 0;
NSString *laborum_ = 0;
int dolore_72;
BOOL Duis_e27;
BOOL do_7b;
BOOL eu_6;
NSString *field = 0;
NSString *operator = 0;
NSString *value = 0;
NSString *strVal = 0;
NSString *active = 0;
NSString *default = 0;
int Elit_0;
int Loreme7;
NSString *app_installation = 0;
NSString *categories = 0;
NSString *permissions = 0;
NSString *usage_1h = 0;
NSString *usage_7d = 0;
NSString *usage_24h = 0;
NSString *usage_30d = 0;
BOOL Ut_2;
BOOL Exf9;
BOOL Magna_5;
BOOL Nostrud_7;
int Ex69c;
NSString *Ut_a = 0;
int Mollit__;
BOOL Deseruntc_;
int Consequatd0;
BOOL Id_4a;
int k;
int count_k;
NSString *count = [jResp StringOf: @"count"];
NSString *next_page = [jResp StringOf: @"next_page"];
NSString *previous_page = [jResp StringOf: @"previous_page"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"workspaces"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
activated = [jResp StringOf: @"workspaces[i].activated"];
created_at = [jResp StringOf: @"workspaces[i].created_at"];
description = [jResp StringOf: @"workspaces[i].description"];
id = [jResp StringOf: @"workspaces[i].id"];
position = [jResp StringOf: @"workspaces[i].position"];
prefer_workspace_app_order = [jResp StringOf: @"workspaces[i].prefer_workspace_app_order"];
ticket_form_id = [jResp StringOf: @"workspaces[i].ticket_form_id"];
title = [jResp StringOf: @"workspaces[i].title"];
updated_at = [jResp StringOf: @"workspaces[i].updated_at"];
url = [jResp StringOf: @"workspaces[i].url"];
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].apps"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
ut_1 = [jResp BoolOf: @"workspaces[i].apps[j].ut_1"];
Lorem_ec = [jResp StringOf: @"workspaces[i].apps[j].Lorem_ec"];
sed_a = [jResp StringOf: @"workspaces[i].apps[j].sed_a"];
laborum_ = [jResp StringOf: @"workspaces[i].apps[j].laborum_"];
dolore_72 = [[jResp IntOf: @"workspaces[i].apps[j].dolore_72"] intValue];
Duis_e27 = [jResp BoolOf: @"workspaces[i].apps[j].Duis_e27"];
do_7b = [jResp BoolOf: @"workspaces[i].apps[j].do_7b"];
eu_6 = [jResp BoolOf: @"workspaces[i].apps[j].eu_6"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].conditions.all"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"workspaces[i].conditions.all[j].field"];
operator = [jResp StringOf: @"workspaces[i].conditions.all[j].operator"];
value = [jResp StringOf: @"workspaces[i].conditions.all[j].value"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].conditions.any"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"workspaces[i].conditions.any[j].field"];
operator = [jResp StringOf: @"workspaces[i].conditions.any[j].operator"];
value = [jResp StringOf: @"workspaces[i].conditions.any[j].value"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].macro_ids"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"workspaces[i].macro_ids[j]"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].macros"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"workspaces[i].macros[j]"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"workspaces[i].selected_macros"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
title = [jResp StringOf: @"workspaces[i].selected_macros[j].title"];
active = [jResp StringOf: @"workspaces[i].selected_macros[j].active"];
created_at = [jResp StringOf: @"workspaces[i].selected_macros[j].created_at"];
default = [jResp StringOf: @"workspaces[i].selected_macros[j].default"];
description = [jResp StringOf: @"workspaces[i].selected_macros[j].description"];
id = [jResp StringOf: @"workspaces[i].selected_macros[j].id"];
position = [jResp StringOf: @"workspaces[i].selected_macros[j].position"];
Elit_0 = [[jResp IntOf: @"workspaces[i].selected_macros[j].restriction.elit_0"] intValue];
Loreme7 = [[jResp IntOf: @"workspaces[i].selected_macros[j].restriction.Loreme7"] intValue];
updated_at = [jResp StringOf: @"workspaces[i].selected_macros[j].updated_at"];
url = [jResp StringOf: @"workspaces[i].selected_macros[j].url"];
app_installation = [jResp StringOf: @"workspaces[i].selected_macros[j].app_installation"];
categories = [jResp StringOf: @"workspaces[i].selected_macros[j].categories"];
permissions = [jResp StringOf: @"workspaces[i].selected_macros[j].permissions"];
usage_1h = [jResp StringOf: @"workspaces[i].selected_macros[j].usage_1h"];
usage_7d = [jResp StringOf: @"workspaces[i].selected_macros[j].usage_7d"];
usage_24h = [jResp StringOf: @"workspaces[i].selected_macros[j].usage_24h"];
usage_30d = [jResp StringOf: @"workspaces[i].selected_macros[j].usage_30d"];
Ut_2 = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.ut_2"];
Exf9 = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.exf9"];
Magna_5 = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.magna_5"];
Nostrud_7 = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.nostrud_7"];
Ex69c = [[jResp IntOf: @"workspaces[i].selected_macros[j].restriction.ex69c"] intValue];
Ut_a = [jResp StringOf: @"workspaces[i].selected_macros[j].restriction.ut_a"];
Mollit__ = [[jResp IntOf: @"workspaces[i].selected_macros[j].restriction.mollit__"] intValue];
Deseruntc_ = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.deseruntc_"];
Consequatd0 = [[jResp IntOf: @"workspaces[i].selected_macros[j].restriction.consequatd0"] intValue];
Id_4a = [jResp BoolOf: @"workspaces[i].selected_macros[j].restriction.id_4a"];
k = 0;
count_k = [[jResp SizeOfArray: @"workspaces[i].selected_macros[j].actions"] intValue];
while (k < count_k) {
jResp.K = [NSNumber numberWithInt: k];
field = [jResp StringOf: @"workspaces[i].selected_macros[j].actions[k].field"];
value = [jResp StringOf: @"workspaces[i].selected_macros[j].actions[k].value"];
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/workspaces
Postman Collection Item JSON
{
"name": "List Workspaces",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
},
"description": "#### Allowed For\n\n* Admins, 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/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"workspaces\": [\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"ut_1\": true\n },\n {\n \"Lorem_ec\": \"ut ipsum nulla voluptate\",\n \"sed_a\": 38535010.16636646\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"elit_0\": 95926683,\n \"Loreme7\": 1915356\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"ut_2\": true,\n \"exf9\": false,\n \"magna_5\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"laborum_\": \"esse elit mollit nulla\",\n \"dolore_72\": 44930495\n },\n {\n \"Duis_e27\": false,\n \"do_7b\": true,\n \"eu_6\": true\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"nostrud_7\": false,\n \"ex69c\": -43731952,\n \"ut_a\": \"anim nostrud pariatur\",\n \"mollit__\": -87941840\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"deseruntc_\": false,\n \"consequatd0\": 17786909,\n \"id_4a\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
