Users represent the individuals that are participating in Kantata OX projects . User objects are often returned as nested JSON objects within other returned items such as posts or tasks.
This endpoint allows you to access all visible users based on the permission level of the requester.
Note: This endpoint relies on project participation and will not return a member of your account who is not in a project. To see all users on the account, use the
on_my_account
option.
If the requester is an Account Administrator, the request will return all users who are participating in a project on the requester's account. In addition, it will return users not on the requester's account if they are participating in any project with an account member (either on the requester's account or their own account).
If the requester is not an Account Administrator, the request will only return users who are participating in a project with the requester.
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
A list of Users have been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "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",
- "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",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "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"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_memberships": {
- "property1": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "account_memberships": {
- "property1": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "work_samples": {
- "property1": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}, - "property2": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}
}
This endpoint allows you to fetch your own data.
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
A list of Users have been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "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",
- "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",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "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"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_memberships": {
- "property1": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "account_memberships": {
- "property1": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "work_samples": {
- "property1": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}, - "property2": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}
}
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "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",
- "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",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "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"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_memberships": {
- "property1": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "account_memberships": {
- "property1": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "work_samples": {
- "property1": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}, - "property2": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}
}
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
{- "user": {
- "full_name": "string",
- "headline": "string",
- "email_address": "string",
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "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",
- "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",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "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"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_memberships": {
- "property1": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "account_memberships": {
- "property1": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "work_samples": {
- "property1": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}, - "property2": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}
}
This endpoint returns a summary of a user's work capacity for a provided range of dates.
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
end_date required | string <date> The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2016-01-01). |
start_date required | string <date> The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2015-12-16). |
include | string Any of the below associations can be included in your request by providing the
|
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
A list of Users have been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "hours": {
- "property1": 0,
- "property2": 0
}
}
Delete the profile photo for the specified user.
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
User has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}
Update the profile photo for the specified user.
This endpoint returns structured User 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 users
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
object | |||
|
{- "user": {
- "profile_photo_attachment_file": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "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",
- "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",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "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"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_memberships": {
- "property1": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "cached_skill_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "level": 0,
- "max_level": 0,
- "skill_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "account_memberships": {
- "property1": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "backup_approver_association_ids": [
- "string"
], - "bill_rate_in_cents": 0,
- "billability_target": 0,
- "can_create_workspace": true,
- "can_view_reports": true,
- "collaborator_only_license": true,
- "cost_rate_ids": [
- "string"
], - "cost_rate_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "default_read_only": true,
- "default_role_id": "string",
- "disabled_at": "2019-08-24T14:15:22Z",
- "effective_workweek_id": "string",
- "future_billable_utilization_ids": [
- "string"
], - "is_administrator": true,
- "is_backup_approver": true,
- "is_owner": true,
- "is_project_lead": true,
- "is_punch_clock_user": true,
- "managee_ids": [
- "string"
], - "manager_can_approve": true,
- "manager_can_edit_skills": true,
- "manager_id": "string",
- "non_participant": true,
- "permission": "string",
- "possible_managee_ids": [
- "string"
], - "possible_manager_ids": [
- "string"
], - "should_show_alert_on_timesheet_submission": true,
- "skill_membership_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "work_samples": {
- "property1": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}, - "property2": {
- "attachment_filename": "string",
- "attachment_id": "string",
- "description": "string",
- "title": "string",
- "trapped_website_url": "string",
- "website_url": "string"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}
}