Get

GET

Get the preferences object.

Query parameters

objectstringRequired

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

type"user_preferences"Required

Type of the preference object to be fetched.

Response

Success.

preferenceobject

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

200Retrieved

1 {
2   "preference": {
3     "type": "user_preferences",
4     "id": "preference",
5     "created_by": {
6       "type": "sys_user",
7       "id": "preference",
8       "display_id": "preference",
9       "display_name": "preference",
10       "display_picture": {
11         "id": "id"
12       },
13       "email": "preference",
14       "full_name": "preference",
15       "state": "active"
16     },
17     "created_date": "2023-01-01T12:00:00Z",
18     "display_id": "preference",
19     "general_preferences": {
20       "preferred_locale": "preferred_locale"
21     },
22     "modified_by": {
23       "type": "sys_user",
24       "id": "preference",
25       "display_id": "preference",
26       "display_name": "preference",
27       "display_picture": {
28         "id": "id"
29       },
30       "email": "preference",
31       "full_name": "preference",
32       "state": "active"
33     },
34     "modified_date": "2023-01-01T12:00:00Z"
35   }
36 }

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	"type": "user_preferences",
4	"id": "preference",
5	"created_by": {
6	"type": "sys_user",
7	"id": "preference",
8	"display_id": "preference",
9	"display_name": "preference",
10	"display_picture": {
11	"id": "id"
12	},
13	"email": "preference",
14	"full_name": "preference",
15	"state": "active"
16	},
17	"created_date": "2023-01-01T12:00:00Z",
18	"display_id": "preference",
19	"general_preferences": {
20	"preferred_locale": "preferred_locale"
21	},
22	"modified_by": {
23	"type": "sys_user",
24	"id": "preference",
25	"display_id": "preference",
26	"display_name": "preference",
27	"display_picture": {
28	"id": "id"
29	},
30	"email": "preference",
31	"full_name": "preference",
32	"state": "active"
33	},
34	"modified_date": "2023-01-01T12:00:00Z"
35	}
36	}