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.
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.
- https://api.mavenlink.com/api/v1https://api.mavenlink.com/api/v1/custom_fields
{ "custom_field": { "name": "string", "value_type": "string", "default_text": "string", "unique_constraint": true, "choices": [ { "label": "string" } ], "custom_field_set_id": 0, "write_access": "string", "read_access": "string" } }
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" } } }