API Documentation

API Endpoint

Custom Field Options

Custom Field Options

GET /api/v2/custom_field_options
Requestsreturns custom field options

GET  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "custom_field_options",
      "attributes": {
        "name": "High",
        "archived_at": null,
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 149
          }
        },
        "custom_field": {
          "data": {
            "type": "custom_fields",
            "id": "1"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 149
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "1"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Get custom field options
GET/api/v2/custom_field_options

GET /api/v2/custom_field_options/1
Requestsreturns custom field options

GET  /api/v2/custom_field_options/2

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "archived_at": null,
      "position": 1,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 150
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "2"
        }
      }
    }
  },
  "included": [
    {
      "id": "2",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 150
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "2"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Gets a custom field option
GET/api/v2/custom_field_options/{id}

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id

POST /api/v2/custom_field_options
Requestscreates custom field optionreturns error

POST  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "custom_field_id": 3,
      "color_id": 1
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "archived_at": null,
      "position": 2,
      "color_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 151
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "3"
        }
      }
    }
  },
  "included": [
    {
      "id": "3",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 151
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "3"
            },
            {
              "type": "custom_field_options",
              "id": "4"
            }
          ]
        }
      }
    },
    {
      "id": "3",
      "type": "custom_field_options",
      "attributes": {
        "name": "High",
        "archived_at": null,
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 151
          }
        },
        "custom_field": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

POST  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "High"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/custom_field"
      }
    }
  ]
}

Creates a custom field option
POST/api/v2/custom_field_options

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id

PATCH /api/v2/custom_field_options/1
Requestsupdates custom field option

PATCH  /api/v2/custom_field_options/6

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "Low"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "6",
    "type": "custom_field_options",
    "attributes": {
      "name": "Low",
      "archived_at": null,
      "position": 1,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 153
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "5"
        }
      }
    }
  },
  "included": [
    {
      "id": "5",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 153
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "6"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Updates a custom field option
PATCH/api/v2/custom_field_options/{id}

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id

PATCH /api/v2/custom_field_options/1/archive
Requestsarchives custom field option

PATCH  /api/v2/custom_field_options/7/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "7",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "archived_at": "2020-08-11T01:04:09.000+02:00",
      "position": 1,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 154
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "6"
        }
      }
    }
  },
  "included": [
    {
      "id": "6",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 154
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "7"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Archives a custom field option
PATCH/api/v2/custom_field_options/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id

Generated by aglio on 10 Aug 2020