Skip to content

Custom Fields

The Custom Fields object allows you to view, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information. If Custom Fields represent the fields themselves, Custom Field Values represent the values in/of those fields.

Operations

Fetching a list of Custom Fields

Request

Returns all Custom Fields, unless filter parameters have been applied.

This endpoint returns structured Custom Field objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_fields top-level JSON key. Please see our Response Format section for more information.

Query
created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger, (int32)

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • choices (CustomFieldChoice) - Includes the ID of a Custom Field's choices.
  • creator (User) - Includes the ID of a Custom Field's creator.
  • custom_field_set (CustomFieldSet) - Includes the ID of the Custom Field Set that a field belongs to.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
matchingstring

Filter by custom fields with a name similar to the specified string.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: name:asc, name:desc, updated_at:asc, and updated_at:desc.

Default:"name:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
subject_typestring

Filters for the specified set of Custom Fields:

  • Estimate
  • Story (Task)
  • User
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource.
updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

GET
/custom_fields
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/custom_fields?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&include=string&matching=string&only=string&order=name%3Aasc&page=1&per_page=20&subject_type=string&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&without_external_reference_service_name=string'

Responses

A list of Custom Fields have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
custom_fieldsobject
external_referencesobject
usersobject
custom_field_choicesobject
custom_field_setsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "custom_fields": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "custom_field_set_id": "string",
      "default_text": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "read_access": 0,
      "unique_constraint": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "value_type": "string",
      "write_access": 0
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "custom_field_set_id": "string",
      "default_text": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "read_access": 0,
      "unique_constraint": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "value_type": "string",
      "write_access": 0
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "custom_field_choices": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_id": "string",
      "external_reference_ids": [
        "string"
      ],
      "label": "string",
      "position": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_id": "string",
      "external_reference_ids": [
        "string"
      ],
      "label": "string",
      "position": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "custom_field_sets": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_ids": [
        "string"
      ],
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_ids": [
        "string"
      ],
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}