Initial
Personas in this Story: Default, Client.
initial command bundles up a lot of data that you might need when you are starting, in a single command. These collections and settings are not personalised, but global and don't change frequently. Collection itself is etagged, so it is recommended for your client to cache it and check for modifications:
Response: HTTP 200, application/json (Hide)
GET /initial
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
{
"settings": {
"identity_name": "Application",
"on_demand": false,
"built_in_language": {
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
},
"default_currency_id": 2,
"default_labels_name_max_length": 30,
"gd_loaded": true,
"wallpaper_url": "http:\/\/feather.dev\/wallpapers\/--WALLPAPER--",
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=--USER-ID--&size=--SIZE--×tamp=--UPDATED-ON--",
"show_visual_editor_toolbar": false,
"timezone": "UTC",
"gmt_offset": 0,
"invoicing_default_due": 15,
"default_project_label_id": null,
"on_invoice_based_on": "keep_records_as_separate_invoice_items",
"notes_and_tasks_as_discussions_enabled": false,
"default_tax_rate_id": null,
"default_expense_category_id": 1,
"invoice_second_tax_is_compound": false,
"invoice_second_tax_is_enabled": false,
"show_project_id": false,
"show_task_id": false,
"task_estimates_enabled": false,
"default_job_type_id": 1,
"default_is_tracking_enabled": false,
"default_is_client_reporting_enabled": false
},
"currencies": [
{
"id": 3,
"class": "Currency",
"url_path": "\/currencies\/3",
"name": "British Pound",
"updated_on": null,
"code": "GBP",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 1,
"class": "Currency",
"url_path": "\/currencies\/1",
"name": "Euro",
"updated_on": null,
"code": "EUR",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 4,
"class": "Currency",
"url_path": "\/currencies\/4",
"name": "Japanese Yen",
"updated_on": null,
"code": "JPY",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 2,
"class": "Currency",
"url_path": "\/currencies\/2",
"name": "US Dollar",
"updated_on": null,
"code": "USD",
"is_default": true,
"decimal_spaces": 2,
"decimal_rounding": 0
}
],
"languages": [
{
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
}
],
"project_categories": [],
"project_labels": [
{
"id": 1,
"class": "ProjectLabel",
"url_path": "\/labels\/1",
"name": "NEW",
"updated_on": null,
"color": "#FFFF00",
"is_default": false,
"position": 1
},
{
"id": 2,
"class": "ProjectLabel",
"url_path": "\/labels\/2",
"name": "INPROGRESS",
"updated_on": null,
"color": "#00A651",
"is_default": false,
"position": 2
},
{
"id": 3,
"class": "ProjectLabel",
"url_path": "\/labels\/3",
"name": "CANCELED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 3
},
{
"id": 4,
"class": "ProjectLabel",
"url_path": "\/labels\/4",
"name": "PAUSED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 4
}
],
"task_labels": [
{
"id": 5,
"class": "TaskLabel",
"url_path": "\/labels\/5",
"name": "NEW",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 1,
"is_global": true
},
{
"id": 6,
"class": "TaskLabel",
"url_path": "\/labels\/6",
"name": "CONFIRMED",
"updated_on": null,
"color": "#F26522",
"is_default": false,
"position": 2,
"is_global": true
},
{
"id": 7,
"class": "TaskLabel",
"url_path": "\/labels\/7",
"name": "WORKS FOR ME",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 3,
"is_global": true
},
{
"id": 8,
"class": "TaskLabel",
"url_path": "\/labels\/8",
"name": "DUPLICATE",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 4,
"is_global": true
},
{
"id": 9,
"class": "TaskLabel",
"url_path": "\/labels\/9",
"name": "WONT FIX",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 5,
"is_global": true
},
{
"id": 10,
"class": "TaskLabel",
"url_path": "\/labels\/10",
"name": "ASSIGNED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 6,
"is_global": true
},
{
"id": 11,
"class": "TaskLabel",
"url_path": "\/labels\/11",
"name": "BLOCKED",
"updated_on": null,
"color": "#ACACAC",
"is_default": false,
"position": 7,
"is_global": true
},
{
"id": 12,
"class": "TaskLabel",
"url_path": "\/labels\/12",
"name": "IN PROGRESS",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 8,
"is_global": true
},
{
"id": 13,
"class": "TaskLabel",
"url_path": "\/labels\/13",
"name": "FIXED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 9,
"is_global": true
},
{
"id": 14,
"class": "TaskLabel",
"url_path": "\/labels\/14",
"name": "REOPENED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 10,
"is_global": true
},
{
"id": 15,
"class": "TaskLabel",
"url_path": "\/labels\/15",
"name": "VERIFIED",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 11,
"is_global": true
}
],
"expense_categories": [
{
"id": 1,
"class": "ExpenseCategory",
"url_path": "\/expense-categories\/1",
"name": "General",
"is_default": true
}
],
"timestamp": 1430163976
}Sleeping for 1 seconds
Response: HTTP 200, application/json (Hide)
GET /initial
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
{
"settings": {
"identity_name": "Application",
"on_demand": false,
"built_in_language": {
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
},
"default_currency_id": 2,
"default_labels_name_max_length": 30,
"gd_loaded": true,
"wallpaper_url": "http:\/\/feather.dev\/wallpapers\/--WALLPAPER--",
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=--USER-ID--&size=--SIZE--×tamp=--UPDATED-ON--",
"show_visual_editor_toolbar": false,
"timezone": "UTC",
"gmt_offset": 0,
"invoicing_default_due": 15,
"default_project_label_id": null,
"on_invoice_based_on": "keep_records_as_separate_invoice_items",
"notes_and_tasks_as_discussions_enabled": false,
"default_tax_rate_id": null,
"default_expense_category_id": 1,
"invoice_second_tax_is_compound": false,
"invoice_second_tax_is_enabled": false,
"show_project_id": false,
"show_task_id": false,
"task_estimates_enabled": false,
"default_job_type_id": 1,
"default_is_tracking_enabled": false,
"default_is_client_reporting_enabled": false
},
"currencies": [
{
"id": 3,
"class": "Currency",
"url_path": "\/currencies\/3",
"name": "British Pound",
"updated_on": null,
"code": "GBP",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 1,
"class": "Currency",
"url_path": "\/currencies\/1",
"name": "Euro",
"updated_on": null,
"code": "EUR",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 4,
"class": "Currency",
"url_path": "\/currencies\/4",
"name": "Japanese Yen",
"updated_on": null,
"code": "JPY",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 2,
"class": "Currency",
"url_path": "\/currencies\/2",
"name": "US Dollar",
"updated_on": null,
"code": "USD",
"is_default": true,
"decimal_spaces": 2,
"decimal_rounding": 0
}
],
"languages": [
{
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
}
],
"project_categories": [],
"project_labels": [
{
"id": 1,
"class": "ProjectLabel",
"url_path": "\/labels\/1",
"name": "NEW",
"updated_on": null,
"color": "#FFFF00",
"is_default": false,
"position": 1
},
{
"id": 2,
"class": "ProjectLabel",
"url_path": "\/labels\/2",
"name": "INPROGRESS",
"updated_on": null,
"color": "#00A651",
"is_default": false,
"position": 2
},
{
"id": 3,
"class": "ProjectLabel",
"url_path": "\/labels\/3",
"name": "CANCELED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 3
},
{
"id": 4,
"class": "ProjectLabel",
"url_path": "\/labels\/4",
"name": "PAUSED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 4
}
],
"task_labels": [
{
"id": 5,
"class": "TaskLabel",
"url_path": "\/labels\/5",
"name": "NEW",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 1,
"is_global": true
},
{
"id": 6,
"class": "TaskLabel",
"url_path": "\/labels\/6",
"name": "CONFIRMED",
"updated_on": null,
"color": "#F26522",
"is_default": false,
"position": 2,
"is_global": true
},
{
"id": 7,
"class": "TaskLabel",
"url_path": "\/labels\/7",
"name": "WORKS FOR ME",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 3,
"is_global": true
},
{
"id": 8,
"class": "TaskLabel",
"url_path": "\/labels\/8",
"name": "DUPLICATE",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 4,
"is_global": true
},
{
"id": 9,
"class": "TaskLabel",
"url_path": "\/labels\/9",
"name": "WONT FIX",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 5,
"is_global": true
},
{
"id": 10,
"class": "TaskLabel",
"url_path": "\/labels\/10",
"name": "ASSIGNED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 6,
"is_global": true
},
{
"id": 11,
"class": "TaskLabel",
"url_path": "\/labels\/11",
"name": "BLOCKED",
"updated_on": null,
"color": "#ACACAC",
"is_default": false,
"position": 7,
"is_global": true
},
{
"id": 12,
"class": "TaskLabel",
"url_path": "\/labels\/12",
"name": "IN PROGRESS",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 8,
"is_global": true
},
{
"id": 13,
"class": "TaskLabel",
"url_path": "\/labels\/13",
"name": "FIXED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 9,
"is_global": true
},
{
"id": 14,
"class": "TaskLabel",
"url_path": "\/labels\/14",
"name": "REOPENED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 10,
"is_global": true
},
{
"id": 15,
"class": "TaskLabel",
"url_path": "\/labels\/15",
"name": "VERIFIED",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 11,
"is_global": true
}
],
"expense_categories": [
{
"id": 1,
"class": "ExpenseCategory",
"url_path": "\/expense-categories\/1",
"name": "General",
"is_default": true
}
],
"timestamp": 1430163976
}If we change one of the properties, like rename an expense category:
Response: HTTP 200, application/json (Hide)
PUT /expense-categories/1
Payload:
1 2 3
{
"name": "Renamed Category"
}Response:
1 2 3 4 5 6 7 8 9
{
"single": {
"id": 1,
"class": "ExpenseCategory",
"url_path": "\/expense-categories\/1",
"name": "Renamed Category",
"is_default": true
}
}Whole response should be timestamped differently:
Response: HTTP 200, application/json (Hide)
GET /initial
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
{
"settings": {
"identity_name": "Application",
"on_demand": false,
"built_in_language": {
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
},
"default_currency_id": 2,
"default_labels_name_max_length": 30,
"gd_loaded": true,
"wallpaper_url": "http:\/\/feather.dev\/wallpapers\/--WALLPAPER--",
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=--USER-ID--&size=--SIZE--×tamp=--UPDATED-ON--",
"show_visual_editor_toolbar": false,
"timezone": "UTC",
"gmt_offset": 0,
"invoicing_default_due": 15,
"default_project_label_id": null,
"on_invoice_based_on": "keep_records_as_separate_invoice_items",
"notes_and_tasks_as_discussions_enabled": false,
"default_tax_rate_id": null,
"default_expense_category_id": 1,
"invoice_second_tax_is_compound": false,
"invoice_second_tax_is_enabled": false,
"show_project_id": false,
"show_task_id": false,
"task_estimates_enabled": false,
"default_job_type_id": 1,
"default_is_tracking_enabled": false,
"default_is_client_reporting_enabled": false
},
"currencies": [
{
"id": 3,
"class": "Currency",
"url_path": "\/currencies\/3",
"name": "British Pound",
"updated_on": null,
"code": "GBP",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 1,
"class": "Currency",
"url_path": "\/currencies\/1",
"name": "Euro",
"updated_on": null,
"code": "EUR",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 4,
"class": "Currency",
"url_path": "\/currencies\/4",
"name": "Japanese Yen",
"updated_on": null,
"code": "JPY",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 2,
"class": "Currency",
"url_path": "\/currencies\/2",
"name": "US Dollar",
"updated_on": null,
"code": "USD",
"is_default": true,
"decimal_spaces": 2,
"decimal_rounding": 0
}
],
"languages": [
{
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
}
],
"project_categories": [],
"project_labels": [
{
"id": 1,
"class": "ProjectLabel",
"url_path": "\/labels\/1",
"name": "NEW",
"updated_on": null,
"color": "#FFFF00",
"is_default": false,
"position": 1
},
{
"id": 2,
"class": "ProjectLabel",
"url_path": "\/labels\/2",
"name": "INPROGRESS",
"updated_on": null,
"color": "#00A651",
"is_default": false,
"position": 2
},
{
"id": 3,
"class": "ProjectLabel",
"url_path": "\/labels\/3",
"name": "CANCELED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 3
},
{
"id": 4,
"class": "ProjectLabel",
"url_path": "\/labels\/4",
"name": "PAUSED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 4
}
],
"task_labels": [
{
"id": 5,
"class": "TaskLabel",
"url_path": "\/labels\/5",
"name": "NEW",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 1,
"is_global": true
},
{
"id": 6,
"class": "TaskLabel",
"url_path": "\/labels\/6",
"name": "CONFIRMED",
"updated_on": null,
"color": "#F26522",
"is_default": false,
"position": 2,
"is_global": true
},
{
"id": 7,
"class": "TaskLabel",
"url_path": "\/labels\/7",
"name": "WORKS FOR ME",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 3,
"is_global": true
},
{
"id": 8,
"class": "TaskLabel",
"url_path": "\/labels\/8",
"name": "DUPLICATE",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 4,
"is_global": true
},
{
"id": 9,
"class": "TaskLabel",
"url_path": "\/labels\/9",
"name": "WONT FIX",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 5,
"is_global": true
},
{
"id": 10,
"class": "TaskLabel",
"url_path": "\/labels\/10",
"name": "ASSIGNED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 6,
"is_global": true
},
{
"id": 11,
"class": "TaskLabel",
"url_path": "\/labels\/11",
"name": "BLOCKED",
"updated_on": null,
"color": "#ACACAC",
"is_default": false,
"position": 7,
"is_global": true
},
{
"id": 12,
"class": "TaskLabel",
"url_path": "\/labels\/12",
"name": "IN PROGRESS",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 8,
"is_global": true
},
{
"id": 13,
"class": "TaskLabel",
"url_path": "\/labels\/13",
"name": "FIXED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 9,
"is_global": true
},
{
"id": 14,
"class": "TaskLabel",
"url_path": "\/labels\/14",
"name": "REOPENED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 10,
"is_global": true
},
{
"id": 15,
"class": "TaskLabel",
"url_path": "\/labels\/15",
"name": "VERIFIED",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 11,
"is_global": true
}
],
"expense_categories": [
{
"id": 1,
"class": "ExpenseCategory",
"url_path": "\/expense-categories\/1",
"name": "Renamed Category",
"is_default": true
}
],
"timestamp": 1430163982
}Sleeping for 1 seconds
Whole response should be timestamped differently:
Response: HTTP 200, application/json (Hide)
GET /initial
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
{
"settings": {
"identity_name": "My Awesome Projects",
"on_demand": false,
"built_in_language": {
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
},
"default_currency_id": 2,
"default_labels_name_max_length": 30,
"gd_loaded": true,
"wallpaper_url": "http:\/\/feather.dev\/wallpapers\/--WALLPAPER--",
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=--USER-ID--&size=--SIZE--×tamp=--UPDATED-ON--",
"show_visual_editor_toolbar": false,
"timezone": "UTC",
"gmt_offset": 0,
"invoicing_default_due": 15,
"default_project_label_id": null,
"on_invoice_based_on": "keep_records_as_separate_invoice_items",
"notes_and_tasks_as_discussions_enabled": false,
"default_tax_rate_id": null,
"default_expense_category_id": 1,
"invoice_second_tax_is_compound": false,
"invoice_second_tax_is_enabled": false,
"show_project_id": false,
"show_task_id": false,
"task_estimates_enabled": false,
"default_job_type_id": 1,
"default_is_tracking_enabled": false,
"default_is_client_reporting_enabled": false
},
"currencies": [
{
"id": 3,
"class": "Currency",
"url_path": "\/currencies\/3",
"name": "British Pound",
"updated_on": null,
"code": "GBP",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 1,
"class": "Currency",
"url_path": "\/currencies\/1",
"name": "Euro",
"updated_on": null,
"code": "EUR",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 4,
"class": "Currency",
"url_path": "\/currencies\/4",
"name": "Japanese Yen",
"updated_on": null,
"code": "JPY",
"is_default": false,
"decimal_spaces": 2,
"decimal_rounding": 0
},
{
"id": 2,
"class": "Currency",
"url_path": "\/currencies\/2",
"name": "US Dollar",
"updated_on": null,
"code": "USD",
"is_default": true,
"decimal_spaces": 2,
"decimal_rounding": 0
}
],
"languages": [
{
"id": 1,
"class": "Language",
"url_path": "\/languages\/1",
"name": "English",
"updated_on": 1430163976,
"locale": "en_US.UTF-8",
"is_default": true
}
],
"project_categories": [],
"project_labels": [
{
"id": 1,
"class": "ProjectLabel",
"url_path": "\/labels\/1",
"name": "NEW",
"updated_on": null,
"color": "#FFFF00",
"is_default": false,
"position": 1
},
{
"id": 2,
"class": "ProjectLabel",
"url_path": "\/labels\/2",
"name": "INPROGRESS",
"updated_on": null,
"color": "#00A651",
"is_default": false,
"position": 2
},
{
"id": 3,
"class": "ProjectLabel",
"url_path": "\/labels\/3",
"name": "CANCELED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 3
},
{
"id": 4,
"class": "ProjectLabel",
"url_path": "\/labels\/4",
"name": "PAUSED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 4
}
],
"task_labels": [
{
"id": 5,
"class": "TaskLabel",
"url_path": "\/labels\/5",
"name": "NEW",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 1,
"is_global": true
},
{
"id": 6,
"class": "TaskLabel",
"url_path": "\/labels\/6",
"name": "CONFIRMED",
"updated_on": null,
"color": "#F26522",
"is_default": false,
"position": 2,
"is_global": true
},
{
"id": 7,
"class": "TaskLabel",
"url_path": "\/labels\/7",
"name": "WORKS FOR ME",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 3,
"is_global": true
},
{
"id": 8,
"class": "TaskLabel",
"url_path": "\/labels\/8",
"name": "DUPLICATE",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 4,
"is_global": true
},
{
"id": 9,
"class": "TaskLabel",
"url_path": "\/labels\/9",
"name": "WONT FIX",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 5,
"is_global": true
},
{
"id": 10,
"class": "TaskLabel",
"url_path": "\/labels\/10",
"name": "ASSIGNED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 6,
"is_global": true
},
{
"id": 11,
"class": "TaskLabel",
"url_path": "\/labels\/11",
"name": "BLOCKED",
"updated_on": null,
"color": "#ACACAC",
"is_default": false,
"position": 7,
"is_global": true
},
{
"id": 12,
"class": "TaskLabel",
"url_path": "\/labels\/12",
"name": "IN PROGRESS",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 8,
"is_global": true
},
{
"id": 13,
"class": "TaskLabel",
"url_path": "\/labels\/13",
"name": "FIXED",
"updated_on": null,
"color": "#0000FF",
"is_default": false,
"position": 9,
"is_global": true
},
{
"id": 14,
"class": "TaskLabel",
"url_path": "\/labels\/14",
"name": "REOPENED",
"updated_on": null,
"color": "#FF0000",
"is_default": false,
"position": 10,
"is_global": true
},
{
"id": 15,
"class": "TaskLabel",
"url_path": "\/labels\/15",
"name": "VERIFIED",
"updated_on": null,
"color": "#00B25C",
"is_default": false,
"position": 11,
"is_global": true
}
],
"expense_categories": [
{
"id": 1,
"class": "ExpenseCategory",
"url_path": "\/expense-categories\/1",
"name": "Renamed Category",
"is_default": true
}
],
"timestamp": 1430163984
}Personalised settings and collections can be checked with /user-session command. This command will tell you more about logged in user (if user is logged in), as well as return some of the settings and collections. Use this command to check if user is logged in a quickly grab a lot of initial data in a single request:
Response: HTTP 200, application/json (Hide)
GET /user-session
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
{
"logged_user_id": 1,
"settings": {
"login_policy": {
"username_format": "email",
"remember_extends_session": true,
"password_change_enabled": true,
"password_recovery_enabled": true,
"external_login_url": null,
"external_logout_url": null,
"external_change_password_url": null,
"external_update_profile_url": null
},
"password_policy": {
"min_length": 0,
"require_numbers": false,
"require_mixed_case": false,
"require_symbols": false
},
"homepage": null,
"wallpaper": "wallpaper.jpg",
"format_date": "%b %e. %Y",
"format_time": "%I:%M %p",
"time_first_week_day": 0,
"timezone": "UTC",
"gmt_offset": 0,
"display_mode_projects": "grid",
"display_mode_project_files": "grid",
"display_mode_project_time": "list",
"display_mode_invoices": "grid",
"display_mode_estimates": "grid",
"group_mode_people": "first_letter",
"sort_mode_projects": "activity",
"sort_mode_project_notes": "recently_updated",
"default_project_label_id": null,
"my_work_projects_order": [],
"my_work_collapsed_sections": [],
"show_visual_editor_toolbar": false
},
"users": [
{
"id": 1,
"class": "Owner",
"url_path": "\/users\/1",
"is_archived": false,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163976,
"created_by_id": 1,
"updated_on": 1430163976,
"updated_by_id": 1,
"language_id": 0,
"first_name": "Ilija.studen",
"last_name": null,
"display_name": "ilija.studen",
"short_display_name": "ilija.studen",
"email": "ilija.studen@activecollab.com",
"additional_email_addresses": [],
"is_pending_activation": false,
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=1&size=--SIZE--×tamp=1430163976",
"custom_permissions": [],
"company_id": 1,
"title": null,
"phone": null,
"im_type": null,
"im_handle": null,
"note": null
},
{
"id": 2,
"class": "Member",
"url_path": "\/users\/2",
"is_archived": false,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"language_id": 0,
"first_name": "Member",
"last_name": null,
"display_name": "member",
"short_display_name": "member",
"email": "member@activecollab.com",
"additional_email_addresses": [],
"is_pending_activation": false,
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=2&size=--SIZE--×tamp=1430163979",
"custom_permissions": [],
"company_id": 1,
"title": null,
"phone": null,
"im_type": null,
"im_handle": null,
"note": null
},
{
"id": 3,
"class": "Client",
"url_path": "\/users\/3",
"is_archived": false,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"language_id": 0,
"first_name": "Client",
"last_name": null,
"display_name": "client",
"short_display_name": "client",
"email": "client@activecollab.com",
"additional_email_addresses": [],
"is_pending_activation": false,
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=3&size=--SIZE--×tamp=1430163979",
"custom_permissions": [],
"company_id": 2,
"title": null,
"phone": null,
"im_type": null,
"im_handle": null,
"note": null
}
],
"companies": [
{
"id": 1,
"class": "Company",
"url_path": "\/companies\/1",
"name": "Owner Company",
"members": [
1,
2
],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"is_archived": false,
"created_on": 1430163976,
"created_by_id": 1,
"updated_on": 1430163976,
"updated_by_id": 1,
"address": null,
"phone": null,
"homepage_url": null,
"tax_id": null,
"currency_id": null,
"is_owner": true,
"has_note": false
},
{
"id": 2,
"class": "Company",
"url_path": "\/companies\/2",
"name": "First Company",
"members": [
3
],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"is_archived": false,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"address": null,
"phone": null,
"homepage_url": null,
"tax_id": null,
"currency_id": null,
"is_owner": false,
"has_note": false
},
{
"id": 3,
"class": "Company",
"url_path": "\/companies\/3",
"name": "Second Company",
"members": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"is_archived": true,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"address": null,
"phone": null,
"homepage_url": null,
"tax_id": null,
"currency_id": null,
"is_owner": false,
"has_note": false
}
],
"projects_total": 2,
"projects": [
{
"id": 1,
"class": "Project",
"url_path": "\/projects\/1",
"name": "Client Project",
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"members": [
1,
3
],
"category_id": 0,
"label_id": 0,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163980,
"created_by_id": 1,
"updated_on": 1430163980,
"updated_by_id": 1,
"body": null,
"body_formatted": "",
"company_id": 2,
"leader_id": 1,
"currency_id": 2,
"template_id": 0,
"based_on_type": null,
"based_on_id": null,
"email": "notifications+m2p-B2bty8H@mail.manageprojects.com",
"is_tracking_enabled": true,
"is_client_reporting_enabled": false,
"budget": null,
"count_tasks": 1,
"count_discussions": 0,
"count_files": 0,
"count_notes": 0
},
{
"id": 2,
"class": "Project",
"url_path": "\/projects\/2",
"name": "Internal Project",
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"members": [
1,
2
],
"category_id": 0,
"label_id": 0,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163981,
"created_by_id": 1,
"updated_on": 1430163981,
"updated_by_id": 1,
"body": null,
"body_formatted": "",
"company_id": 1,
"leader_id": 1,
"currency_id": 2,
"template_id": 0,
"based_on_type": null,
"based_on_id": null,
"email": "notifications+m2p-JDcZ5M1@mail.manageprojects.com",
"is_tracking_enabled": true,
"is_client_reporting_enabled": false,
"budget": null,
"count_tasks": 0,
"count_discussions": 0,
"count_files": 0,
"count_notes": 0
}
],
"system_notifications": [],
"job_types": [
{
"id": 1,
"class": "JobType",
"url_path": "\/job-types\/1",
"name": "General",
"is_archived": false,
"updated_on": null,
"is_default": true,
"default_hourly_rate": 100
}
],
"favorites": [
{
"parent_id": 1,
"parent_type": "Project"
}
]
}When executed as client, /user-session will return a bit different result:
Response: HTTP 200, application/json (Hide)
GET /user-session (as Client)
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
{
"logged_user_id": 3,
"settings": {
"login_policy": {
"username_format": "email",
"remember_extends_session": true,
"password_change_enabled": true,
"password_recovery_enabled": true,
"external_login_url": null,
"external_logout_url": null,
"external_change_password_url": null,
"external_update_profile_url": null
},
"password_policy": {
"min_length": 0,
"require_numbers": false,
"require_mixed_case": false,
"require_symbols": false
},
"homepage": null,
"wallpaper": "wallpaper.jpg",
"format_date": "%b %e. %Y",
"format_time": "%I:%M %p",
"time_first_week_day": 0,
"timezone": "UTC",
"gmt_offset": 0,
"display_mode_projects": "grid",
"display_mode_project_files": "grid",
"display_mode_project_time": "list",
"display_mode_invoices": "grid",
"display_mode_estimates": "grid",
"group_mode_people": "first_letter",
"sort_mode_projects": "activity",
"sort_mode_project_notes": "recently_updated",
"default_project_label_id": null,
"my_work_projects_order": [],
"my_work_collapsed_sections": [],
"show_visual_editor_toolbar": false
},
"users": [
{
"id": 1,
"class": "Owner",
"url_path": "\/users\/1",
"is_archived": false,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163976,
"created_by_id": 1,
"updated_on": 1430163976,
"updated_by_id": 1,
"language_id": 0,
"first_name": "Ilija.studen",
"last_name": null,
"display_name": "ilija.studen",
"short_display_name": "ilija.studen",
"email": "ilija.studen@activecollab.com",
"additional_email_addresses": [],
"is_pending_activation": false,
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=1&size=--SIZE--×tamp=1430163976",
"custom_permissions": [],
"company_id": 1,
"title": null,
"phone": null,
"im_type": null,
"im_handle": null,
"note": null
},
{
"id": 3,
"class": "Client",
"url_path": "\/users\/3",
"is_archived": false,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"language_id": 0,
"first_name": "Client",
"last_name": null,
"display_name": "client",
"short_display_name": "client",
"email": "client@activecollab.com",
"additional_email_addresses": [],
"is_pending_activation": false,
"avatar_url": "http:\/\/feather.dev\/proxy.php?proxy=avatar&module=system&v=current&b=DEV&user_id=3&size=--SIZE--×tamp=1430163979",
"custom_permissions": [],
"company_id": 2,
"title": null,
"phone": null,
"im_type": null,
"im_handle": null,
"note": null
}
],
"companies": [
{
"id": 1,
"class": "Company",
"url_path": "\/companies\/1",
"name": "Owner Company",
"members": [
1,
2
],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"is_archived": false,
"created_on": 1430163976,
"created_by_id": 1,
"updated_on": 1430163976,
"updated_by_id": 1,
"address": null,
"phone": null,
"homepage_url": null,
"tax_id": null,
"currency_id": null,
"is_owner": true,
"has_note": false
},
{
"id": 2,
"class": "Company",
"url_path": "\/companies\/2",
"name": "First Company",
"members": [
3
],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"is_archived": false,
"created_on": 1430163979,
"created_by_id": 1,
"updated_on": 1430163979,
"updated_by_id": 1,
"address": null,
"phone": null,
"homepage_url": null,
"tax_id": null,
"currency_id": null,
"is_owner": false,
"has_note": false
}
],
"projects_total": 1,
"projects": [
{
"id": 1,
"class": "Project",
"url_path": "\/projects\/1",
"name": "Client Project",
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"members": [
1,
3
],
"category_id": 0,
"label_id": 0,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430163980,
"created_by_id": 1,
"updated_on": 1430163980,
"updated_by_id": 1,
"body": null,
"body_formatted": "",
"company_id": 2,
"leader_id": 1,
"currency_id": 2,
"template_id": 0,
"based_on_type": null,
"based_on_id": null,
"email": "notifications+m2p-B2bty8H@mail.manageprojects.com",
"is_tracking_enabled": true,
"is_client_reporting_enabled": false,
"budget": null,
"count_tasks": 1,
"count_discussions": 0,
"count_files": 0,
"count_notes": 0
}
],
"system_notifications": [],
"job_types": [
{
"id": 1,
"class": "JobType",
"url_path": "\/job-types\/1",
"name": "General",
"is_archived": false,
"updated_on": null,
"is_default": true,
"default_hourly_rate": 100
}
],
"favorites": []
}
