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

GET

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

200Retrieved

1 {
2   "preference": {
3     "type": "user_preferences",
4     "id": "id",
5     "created_by": {
6       "type": "dev_user",
7       "id": "id",
8       "display_id": "display_id",
9       "display_name": "display_name",
10       "display_picture": {
11         "id": "id",
12         "file": {}
13       },
14       "email": "email",
15       "full_name": "full_name",
16       "state": "active"
17     },
18     "created_date": "created_date",
19     "display_id": "display_id",
20     "general_preferences": {
21       "availability": {
22         "manual_away": true
23       },
24       "preferred_locale": "preferred_locale"
25     },
26     "modified_by": {
27       "type": "dev_user",
28       "id": "id",
29       "display_id": "display_id",
30       "display_name": "display_name",
31       "display_picture": {
32         "id": "id",
33         "file": {}
34       },
35       "email": "email",
36       "full_name": "full_name",
37       "state": "active"
38     },
39     "modified_date": "modified_date"
40   }
41 }

Get Preference (POST)

Up Next

Built with

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

1	{
2	"preference": {
3	"type": "user_preferences",
4	"id": "id",
5	"created_by": {
6	"type": "dev_user",
7	"id": "id",
8	"display_id": "display_id",
9	"display_name": "display_name",
10	"display_picture": {
11	"id": "id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"display_id": "display_id",
20	"general_preferences": {
21	"availability": {
22	"manual_away": true
23	},
24	"preferred_locale": "preferred_locale"
25	},
26	"modified_by": {
27	"type": "dev_user",
28	"id": "id",
29	"display_id": "display_id",
30	"display_name": "display_name",
31	"display_picture": {
32	"id": "id",
33	"file": {}
34	},
35	"email": "email",
36	"full_name": "full_name",
37	"state": "active"
38	},
39	"modified_date": "modified_date"
40	}
41	}