Project Field

Retrieve Project Fields

GET

Retrieves all ProjectFields defined within your Workspace.

A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
$curl /api/data/projects/fields \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": [
13    {
14      "id": "id",
15      "name": "name",
16      "type": "type",
17      "entityType": "entityType",
18      "options": [
19        "options"
20      ],
21      "shortId": "shortId"
22    }
23  ]
24}
Built with