Get Preference

GET

Get the preferences object.

Query parameters

objectstringRequired

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

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     "created_by": {
5       "type": "dev_user",
6       "display_picture": {
7         "file": {
8           "type": "type",
9           "name": "name"
10         },
11         "id": "id",
12         "display_id": "display_id"
13       },
14       "id": "id",
15       "state": "active",
16       "display_id": "display_id",
17       "display_name": "display_name",
18       "email": "email",
19       "full_name": "full_name"
20     },
21     "general_preferences": {
22       "availability": {
23         "manual_away": true
24       },
25       "preferred_locale": "preferred_locale"
26     },
27     "id": "id",
28     "modified_by": {
29       "type": "dev_user",
30       "display_picture": {
31         "file": {
32           "type": "type",
33           "name": "name"
34         },
35         "id": "id",
36         "display_id": "display_id"
37       },
38       "id": "id",
39       "state": "active",
40       "display_id": "display_id",
41       "display_name": "display_name",
42       "email": "email",
43       "full_name": "full_name"
44     },
45     "created_date": "created_date",
46     "display_id": "display_id",
47     "modified_date": "modified_date"
48   }
49 }

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	"created_by": {
5	"type": "dev_user",
6	"display_picture": {
7	"file": {
8	"type": "type",
9	"name": "name"
10	},
11	"id": "id",
12	"display_id": "display_id"
13	},
14	"id": "id",
15	"state": "active",
16	"display_id": "display_id",
17	"display_name": "display_name",
18	"email": "email",
19	"full_name": "full_name"
20	},
21	"general_preferences": {
22	"availability": {
23	"manual_away": true
24	},
25	"preferred_locale": "preferred_locale"
26	},
27	"id": "id",
28	"modified_by": {
29	"type": "dev_user",
30	"display_picture": {
31	"file": {
32	"type": "type",
33	"name": "name"
34	},
35	"id": "id",
36	"display_id": "display_id"
37	},
38	"id": "id",
39	"state": "active",
40	"display_id": "display_id",
41	"display_name": "display_name",
42	"email": "email",
43	"full_name": "full_name"
44	},
45	"created_date": "created_date",
46	"display_id": "display_id",
47	"modified_date": "modified_date"
48	}
49	}