Project Field

Retrieve ProjectField Value

GET

Retrieves the current ProjectField value for a particular Project and ProjectField.

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.

Path parameters

projectIdstringRequired
The unique identifier of the Project of the value to retrieve
fieldIdstringRequired
The unique identifier or short ID of the ProjectField of the value to retrieve

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
objectOptional
A model that contains the value for a ProjectField.
GET
$curl /api/data/projects/projectId/fields/fieldId \
>     -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    "id": "id",
14    "shortId": "shortId",
15    "name": "name",
16    "type": "type",
17    "value": "value",
18    "createdDate": "2024-01-15T09:30:00Z",
19    "modifiedDate": "2024-01-15T09:30:00Z"
20  }
21}
Built with