List Properties

GET

https://api.coperniq.io/v1/properties

GET

/v1/properties

1 curl https://api.coperniq.io/v1/properties \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "projects": [
3     {
4       "name": "Project Status",
5       "type": "string",
6       "keyName": "status",
7       "isMultiple": false,
8       "options": [
9         "planned",
10         "in_progress",
11         "completed",
12         "on_hold"
13       ],
14       "defaultValue": [
15         "planned"
16       ]
17     },
18     {
19       "name": "Project Value",
20       "type": "number",
21       "keyName": "value",
22       "isMultiple": false,
23       "options": [],
24       "defaultValue": [
25         0
26       ]
27     }
28   ],
29   "accounts": [
30     {
31       "name": "Account Industry",
32       "type": "string",
33       "keyName": "industry",
34       "isMultiple": false,
35       "options": [
36         "technology",
37         "finance",
38         "healthcare",
39         "education"
40       ],
41       "defaultValue": [
42         "technology"
43       ]
44     },
45     {
46       "name": "Account Size",
47       "type": "string",
48       "keyName": "size",
49       "isMultiple": false,
50       "options": [
51         "small",
52         "medium",
53         "large"
54       ],
55       "defaultValue": [
56         "medium"
57       ]
58     }
59   ],
60   "opportunities": [
61     {
62       "name": "Opportunity Priority",
63       "type": "string",
64       "keyName": "priority",
65       "isMultiple": false,
66       "options": [
67         "low",
68         "medium",
69         "high",
70         "urgent"
71       ],
72       "defaultValue": [
73         "medium"
74       ]
75     },
76     {
77       "name": "Opportunity Type",
78       "type": "string",
79       "keyName": "type",
80       "isMultiple": false,
81       "options": [
82         "bug",
83         "feature",
84         "support"
85       ],
86       "defaultValue": [
87         "support"
88       ]
89     }
90   ]
91 }

Retrieve list of properties organized by record type.

Authentication

x-api-keystring

API Key authentication via header

Response

List of properties

projectslist of objects or null

accountslist of objects or null

opportunitieslist of objects or null