Get Custom field

GET /api/v1.0/fields/{field_id}

Bearer

This endpoint provides details of the custom field in the project.

Path parameters

field_id string Required

Responses

200

Success Response
Hide response attributes Show response attributes object
- id string Required
  
  ID
- name string Required
  
  Name
- description string Required
  
  Description
- type string Required
  
  Type
- currency string Required
  
  Currency
- tracking_type string Required
  
  Tracking Type
- cost_per_hour number Required
  
  Cost Per Hour
- associations array[string] Required
  
  List of associations
- hidden array[string] Required
  
  List of hidden
- options array[object] Required
  
  Hide options attributes Show options attributes array[object]
  
  id string Required
  
  ID
  
  value string Required
  
  Value
  
  color string Required
  
  Color
- projects array[string] Required
  
  List of Projects
- in_library boolean Required
401

The client request has not been completed because it lacks valid authentication credentials for the requested resource.
403

The client does not have access rights to the content.
405

The request method is known by the server but is not supported by the target resource.

GET /api/v1.0/fields/{field_id}

curl \
 -X GET https://openapi.niftypm.com/api/v1.0/fields/{field_id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "currency": "string",
  "tracking_type": "string",
  "cost_per_hour": 42.0,
  "associations": [
    "string"
  ],
  "hidden": [
    "string"
  ],
  "options": [
    {
      "id": "string",
      "value": "string",
      "color": "string"
    }
  ],
  "projects": [
    "string"
  ],
  "in_library": true
}

Response examples (200)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "currency": "string",
  "tracking_type": "string",
  "cost_per_hour": 42.0,
  "associations": [
    "string"
  ],
  "hidden": [
    "string"
  ],
  "options": [
    {
      "id": "string",
      "value": "string",
      "color": "string"
    }
  ],
  "projects": [
    "string"
  ],
  "in_library": true
}