Get Preference

GET

Get the preferences object.

Query parameters

objectstringRequiredformat: "id"

The ID of the target object for which preferences object is to be fetched.

typeenumRequired

Type of the preference object to be fetched.

Allowed values: user_preferences

language_codestringOptionalformat: "text"

Language code for which to get the preferences for.

Response

Success.

preferenceobject

Errors

GET

1 curl -G https://api.devrev.ai/preferences.get \
2      -H "Authorization: Bearer <token>" \
3      -d object=DEV-AbCdEfGh \
4      -d type=user_preferences

200getExample

1 {
2   "preference": {
3     "created_by": {
4       "display_id": "foo",
5       "id": "foo",
6       "display_name": "foo",
7       "display_picture": {
8         "display_id": "foo",
9         "id": "foo",
10         "file": {
11           "type": "foo",
12           "name": "foo",
13           "size": 42
14         }
15       },
16       "email": "foo",
17       "full_name": "foo",
18       "state": "active"
19     },
20     "created_date": "2023-01-01T12:00:00.000Z",
21     "display_id": "foo",
22     "id": "foo",
23     "modified_by": {
24       "display_id": "foo",
25       "id": "foo",
26       "display_name": "foo",
27       "display_picture": {
28         "display_id": "foo",
29         "id": "foo",
30         "file": {
31           "type": "foo",
32           "name": "foo",
33           "size": 42
34         }
35       },
36       "email": "foo",
37       "full_name": "foo",
38       "state": "active"
39     },
40     "modified_date": "2023-01-01T12:00:00.000Z",
41     "general_preferences": {
42       "availability": {
43         "manual_away": true
44       },
45       "preferred_locale": "foo"
46     }
47   }
48 }

Get Preference (POST)

Up Next

Built with

1	curl -G https://api.devrev.ai/preferences.get \
2	-H "Authorization: Bearer <token>" \
3	-d object=DEV-AbCdEfGh \
4	-d type=user_preferences

1	{
2	"preference": {
3	"created_by": {
4	"display_id": "foo",
5	"id": "foo",
6	"display_name": "foo",
7	"display_picture": {
8	"display_id": "foo",
9	"id": "foo",
10	"file": {
11	"type": "foo",
12	"name": "foo",
13	"size": 42
14	}
15	},
16	"email": "foo",
17	"full_name": "foo",
18	"state": "active"
19	},
20	"created_date": "2023-01-01T12:00:00.000Z",
21	"display_id": "foo",
22	"id": "foo",
23	"modified_by": {
24	"display_id": "foo",
25	"id": "foo",
26	"display_name": "foo",
27	"display_picture": {
28	"display_id": "foo",
29	"id": "foo",
30	"file": {
31	"type": "foo",
32	"name": "foo",
33	"size": 42
34	}
35	},
36	"email": "foo",
37	"full_name": "foo",
38	"state": "active"
39	},
40	"modified_date": "2023-01-01T12:00:00.000Z",
41	"general_preferences": {
42	"availability": {
43	"manual_away": true
44	},
45	"preferred_locale": "foo"
46	}
47	}
48	}