RolesRemoveAssignmentRequest
{
"type": "object",
"title": "deleteRoleAssignmentRequest",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user"
}
}
}
RolesRemoveAssignmentResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the role the user was removed from"
}
},
"description": "The response data"
}
}
}
],
"title": "deleteRoleAssignmentResponse200"
}
RolesUpdatePipelineVisibilityRequest
{
"type": "object",
"title": "putRolePipelinesBody",
"required": [
"visible_pipeline_ids"
],
"properties": {
"visible_pipeline_ids": {
"type": "object",
"description": "The pipeline IDs to make the pipelines visible (add) and/or hidden (remove) for the specified role. It requires the following JSON structure: `{ \"add\": \"[1]\", \"remove\": \"[3, 4]\" }`."
}
}
}
RolesUpdatePipelineVisibilityResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"visible": {
"type": "boolean",
"description": "Whether visible or hidden pipeline ids were returned"
},
"pipeline_ids": {
"type": "array",
"items": {
"type": "number",
"description": "The ID of the pipeline"
},
"description": "Either visible or hidden pipeline ids"
}
},
"description": "The response data"
}
}
}
],
"title": "getRolePipelines200"
}
RolesUpdateRoleDetailsRequest
{
"type": "object",
"title": "baseRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the role"
},
"parent_role_id": {
"type": "integer",
"description": "The ID of the parent role"
}
},
"description": "The details of the role"
}
RolesUpdateRoleDetailsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the updated role"
}
},
"description": "The response data"
}
}
}
],
"title": "updateRoleResponse200"
}
StagesCreateNewStageRequest
{
"type": "object",
"title": "addStageRequest",
"required": [
"name",
"pipeline_id"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the stage"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when deal weighted values are used."
}
}
}
StagesCreateNewStageResponse
{
"type": "object",
"title": "stageResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
},
"description": "Updated stage object"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
StagesDeleteBulkResponse
{
"type": "object",
"title": "deleteStagesResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of deleted stage IDs"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
StagesDeleteStageResponse
{
"type": "object",
"title": "deleteStageResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Deleted stage ID"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
StagesGetAllResponse
{
"type": "object",
"title": "getStagesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
}
},
{
"type": "object",
"properties": {
"pipeline_name": {
"type": "string",
"description": "The name of the pipeline"
},
"pipeline_deal_probability": {
"type": "boolean",
"description": "The pipeline deal probability. When `true`, overrides the stage probability."
}
}
}
]
},
"description": "The array of stages"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
StagesGetOneStageResponse
{
"type": "object",
"title": "getStageResponse200",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
}
},
{
"type": "object",
"properties": {
"deals_summary": {
"type": "object",
"properties": {
"per_stages": {
"type": "object",
"properties": {
"STAGE_ID": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Deals count per currency"
},
"value": {
"type": "integer",
"description": "Deals value per currency"
},
"weighted_value": {
"type": "integer",
"description": "Deals weighted value per currency"
},
"value_formatted": {
"type": "string",
"description": "Deals value formatted per currency"
},
"weighted_value_formatted": {
"type": "string",
"description": "Deals weighted value formatted per currency"
}
},
"description": "The currency summary. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "The currency summaries per stage. This parameter is dynamic and changes according to `stage_id` value."
}
},
"description": "The stage objects containing deals currency information"
},
"total_count": {
"type": "integer",
"description": "Deals count"
},
"per_currency": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "Deals count per currency. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "The currency count summary"
},
"per_currency_full": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Deals count per currency"
},
"value": {
"type": "integer",
"description": "Deals value per currency"
}
},
"description": "The currency summary. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "Full currency summaries"
}
},
"description": "Deals summary"
}
}
}
],
"description": "The stage object"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
StagesGetStageDealsResponse
{
"type": "object",
"title": "getStageDealsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization associated with the deal"
},
"user_id": {
"type": "integer",
"description": "The ID of the user"
},
"person_id": {
"type": "integer",
"description": "The ID of the person associated with the deal"
},
"creator_user_id": {
"type": "integer",
"description": "The ID of the deal creator"
}
}
},
{
"type": "object",
"title": "baseDeal",
"properties": {
"label": {
"type": "string",
"description": "The label or multiple labels assigned to the deal"
},
"title": {
"type": "string",
"description": "The title of the deal"
},
"value": {
"type": "number",
"description": "The value of the deal"
},
"active": {
"type": "boolean",
"description": "Whether the deal is active or not"
},
"status": {
"type": "string",
"description": "The status of the deal"
},
"deleted": {
"type": "boolean",
"description": "Whether the deal is deleted or not"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the deal"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the deal"
},
"currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the deal"
},
"stage_id": {
"type": "integer",
"description": "The ID of the deal stage"
},
"won_time": {
"type": "string",
"description": "The date and time of changing the deal status as won"
},
"lost_time": {
"type": "string",
"description": "The date and time of changing the deal status as lost"
},
"close_time": {
"type": "string",
"nullable": true,
"description": "The date and time of closing the deal"
},
"org_hidden": {
"type": "boolean",
"description": "If the organization that is associated with the deal is hidden or not"
},
"owner_name": {
"type": "string",
"description": "The name of the deal owner"
},
"visible_to": {
"type": "string",
"description": "The visibility of the deal"
},
"files_count": {
"type": "integer",
"description": "The number of files associated with the deal"
},
"lost_reason": {
"type": "string",
"nullable": true,
"description": "The reason for losing the deal"
},
"notes_count": {
"type": "integer",
"description": "The number of notes associated with the deal"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the deal"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline associated with the deal"
},
"probability": {
"type": "number",
"nullable": true,
"description": "The success probability percentage of the deal"
},
"rotten_time": {
"type": "string",
"nullable": true,
"description": "The date and time of changing the deal status as rotten"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the deal"
},
"person_hidden": {
"type": "boolean",
"description": "If the person that is associated with the deal is hidden or not"
},
"first_won_time": {
"type": "string",
"description": "The date and time of the first time changing the deal status as won"
},
"products_count": {
"type": "integer",
"description": "The number of products associated with the deal"
},
"stage_order_nr": {
"type": "integer",
"description": "The order number of the deal stage associated with the deal"
},
"weighted_value": {
"type": "number",
"description": "Probability times deal value. Probability can either be deal probability or if not set, then stage probability."
},
"followers_count": {
"type": "integer",
"description": "The number of followers associated with the deal"
},
"formatted_value": {
"type": "string",
"description": "The deal value formatted with selected currency. E.g. US$500"
},
"activities_count": {
"type": "integer",
"description": "The number of activities associated with the deal"
},
"last_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the last activity associated with the deal"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the deal"
},
"stage_change_time": {
"type": "string",
"description": "The last updated date and time of the deal stage"
},
"last_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the last activity associated with the deal"
},
"next_activity_date": {
"type": "string",
"description": "The date of the next activity associated with the deal"
},
"next_activity_note": {
"type": "string",
"description": "The note of the next activity associated with the deal"
},
"next_activity_time": {
"type": "string",
"description": "The time of the next activity associated with the deal"
},
"next_activity_type": {
"type": "string",
"description": "The type of the next activity associated with the deal"
},
"participants_count": {
"type": "integer",
"description": "The number of participants associated with the deal"
},
"expected_close_date": {
"type": "string",
"format": "date",
"description": "The expected close date of the deal"
},
"email_messages_count": {
"type": "integer",
"description": "The number of emails associated with the deal"
},
"done_activities_count": {
"type": "integer",
"description": "The number of completed activities associated with the deal"
},
"next_activity_subject": {
"type": "string",
"description": "The subject of the next activity associated with the deal"
},
"next_activity_duration": {
"type": "string",
"description": "The duration of the next activity associated with the deal"
},
"last_incoming_mail_time": {
"type": "string",
"description": "The date and time of the last incoming email associated with the deal"
},
"last_outgoing_mail_time": {
"type": "string",
"description": "The date and time of the last outgoing email associated with the deal"
},
"undone_activities_count": {
"type": "integer",
"description": "The number of incomplete activities associated with the deal"
},
"weighted_value_currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"formatted_weighted_value": {
"type": "string",
"description": "The weighted_value formatted with selected currency. E.g. US$500"
}
}
}
],
"title": "dealStrict"
},
"description": "The array of deals"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
},
"additional_data": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
}
}
}
StagesUpdateDetailsRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the stage"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when deal weighted values are used."
}
}
},
{
"type": "object",
"properties": {
"order_nr": {
"type": "integer",
"description": "An order number for this stage. Order numbers should be used to order the stages in the pipeline."
}
}
}
],
"title": "updateStageRequest"
}
StagesUpdateDetailsResponse
{
"type": "object",
"title": "stageResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
},
"description": "Updated stage object"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
SubscriptionsAddInstallmentSubscriptionRequest
{
"type": "object",
"title": "addSubscriptionInstallmentRequest",
"required": [
"deal_id",
"currency",
"payments"
],
"properties": {
"deal_id": {
"type": "integer",
"description": "The ID of the deal this installment subscription is associated with"
},
"currency": {
"type": "string",
"description": "The currency of the installment subscription. Accepts a 3-character currency code."
},
"payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD)."
},
"update_deal_value": {
"type": "boolean",
"description": "Indicates that the deal value must be set to the installment subscription's total value"
}
}
}
SubscriptionsAddInstallmentSubscriptionResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsAddRecurringRequest
{
"type": "object",
"title": "addRecurringSubscriptionRequest",
"required": [
"deal_id",
"currency",
"cadence_type",
"start_date",
"cycle_amount"
],
"properties": {
"deal_id": {
"type": "integer",
"description": "The ID of the deal this recurring subscription is associated with"
},
"currency": {
"type": "string",
"description": "The currency of the recurring subscription. Accepts a 3-character currency code."
},
"infinite": {
"type": "boolean",
"description": "This indicates that the recurring subscription will last until it's manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`."
},
"payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD)."
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription. Format: YYYY-MM-DD"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"cadence_type": {
"enum": [
"weekly",
"monthly",
"quarterly",
"yearly"
],
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required."
},
"update_deal_value": {
"type": "boolean",
"description": "Indicates that the deal value must be set to recurring subscription's MRR value"
}
}
}
SubscriptionsAddRecurringResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsCancelRecurringSubscriptionRequest
{
"type": "object",
"title": "cancelRecurringSubscriptionRequest",
"required": [
"id"
],
"properties": {
"end_date": {
"type": "string",
"format": "date",
"description": "The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date."
}
}
}
SubscriptionsCancelRecurringSubscriptionResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsDeleteMarkedResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsFindByDealIdResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsGetDetailsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsGetPaymentsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the payment"
},
"amount": {
"type": "number",
"format": "double",
"description": "The payment amount"
},
"due_at": {
"type": "string",
"format": "date",
"description": "The date when payment occurs"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this payment is associated with"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the payment"
},
"currency": {
"type": "string",
"description": "The currency of the payment"
},
"is_active": {
"type": "boolean",
"description": "The payment status"
},
"description": {
"type": "string",
"description": "The description of the payment"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the payment"
},
"payment_type": {
"enum": [
"recurring",
"additional",
"installment"
],
"type": "string",
"description": "The type of the payment. Possible values are: `Recurring` - payments occur over fixed intervals of time, `Additional` - extra payment not the recurring payment of the recurring subscription, `Installment` - payment of the installment subscription."
},
"change_amount": {
"type": "number",
"format": "double",
"description": "The difference between the amount of the current payment and the previous payment. The value can be either positive or negative."
},
"subscription_id": {
"type": "integer",
"description": "The ID of the subscription this payment is associated with"
},
"revenue_movement_type": {
"enum": [
"new",
"recurring",
"expansion",
"contraction",
"none",
"churn"
],
"type": "string",
"description": "Represents the movement of revenue in comparison with the previous payment. Possible values are: `New` - first payment of the subscription. `Recurring` - no movement. `Expansion` - current payment amount > previous payment amount. `Contraction` - current payment amount < previous payment amount. `Churn` - last payment of the subscription."
}
}
}
}
}
}
],
"title": "paymentResponse200"
}
SubscriptionsUpdateInstallmentSubscriptionRequest
{
"type": "object",
"title": "updateSubscriptionInstallmentRequest",
"required": [
"id",
"payments"
],
"properties": {
"payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD)."
},
"update_deal_value": {
"type": "boolean",
"description": "Indicates that the deal value must be set to installment subscription's total value"
}
}
}
SubscriptionsUpdateInstallmentSubscriptionResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
SubscriptionsUpdateRecurringRequest
{
"type": "object",
"title": "updateRecurringSubscriptionRequest",
"required": [
"id",
"effective_date"
],
"properties": {
"payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD)."
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"effective_date": {
"type": "string",
"format": "date",
"description": "All payments after that date will be affected. Format: YYYY-MM-DD"
},
"update_deal_value": {
"type": "boolean",
"description": "Indicates that the deal value must be set to recurring subscription's MRR value"
}
}
}
SubscriptionsUpdateRecurringResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the subscription"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this subscription is associated with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the subscription"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the subscription"
},
"currency": {
"type": "string",
"description": "The currency of the subscription"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the subscription"
},
"infinite": {
"type": "boolean",
"description": "Indicates that the recurring subscription will last until it is manually canceled or deleted"
},
"is_active": {
"type": "boolean",
"description": "The subscription status"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the recurring subscription"
},
"description": {
"type": "string",
"description": "The description of the recurring subscription"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the subscription"
},
"cadence_type": {
"type": "string",
"description": "The interval between payments"
},
"cycle_amount": {
"type": "integer",
"description": "The amount of each payment"
},
"cycles_count": {
"type": "integer",
"description": "Shows how many payments a recurring subscription has"
},
"final_status": {
"type": "string",
"nullable": true,
"description": "The final status of the subscription"
},
"lifetime_value": {
"type": "number",
"format": "double",
"description": "The total value of all payments"
}
}
}
}
}
],
"title": "subscriptionsIdResponse200"
}
TasksCreateTaskRequest
{
"allOf": [
{
"type": "object",
"title": "requiedPostProjectParameters",
"required": [
"title",
"project_id"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of a project"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
}
],
"title": "addTaskRequest"
}
TasksCreateTaskResponse
{
"type": "object",
"title": "addTaskResponse201",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"creator_id": {
"type": "number",
"description": "The creator of a task"
},
"update_time": {
"type": "string",
"description": "The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"marked_as_done_time": {
"type": "string",
"description": "The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "updateProjectRequest"
}
],
"title": "taskResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
TasksDeleteTaskResponse
{
"type": "object",
"title": "deleteTaskResponse200",
"properties": {
"data": {
"type": "object",
"title": "deleteTask",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task that was deleted"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
TasksGetDetailsResponse
{
"type": "object",
"title": "getTaskResponse200",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"creator_id": {
"type": "number",
"description": "The creator of a task"
},
"update_time": {
"type": "string",
"description": "The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"marked_as_done_time": {
"type": "string",
"description": "The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "updateProjectRequest"
}
],
"title": "taskResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
TasksListAllTasksResponse
{
"type": "object",
"title": "getTasksResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"creator_id": {
"type": "number",
"description": "The creator of a task"
},
"update_time": {
"type": "string",
"description": "The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"marked_as_done_time": {
"type": "string",
"description": "The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "updateProjectRequest"
}
],
"title": "taskResponseObject"
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"description": "The additional data of the list"
}
}
}
TasksUpdateTaskRequest
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
}
],
"title": "updateProjectRequest"
}
TasksUpdateTaskResponse
{
"type": "object",
"title": "updateTaskResponse200",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"creator_id": {
"type": "number",
"description": "The creator of a task"
},
"update_time": {
"type": "string",
"description": "The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"marked_as_done_time": {
"type": "string",
"description": "The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "updateProjectRequest"
}
],
"title": "taskResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
UserConnectionsGetAllConnections401Response
{
"type": "object",
"title": "unathorizedResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"errorCode": {
"type": "integer",
"description": "The response error code"
}
}
}
UserConnectionsGetAllConnectionsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"google": {
"type": "string",
"description": "The third party ID or false in case the ID is not found"
}
},
"description": "The object of UserConnections"
}
}
}
],
"title": "userConnectionsResponse200"
}
UserSettingsListAuthorizedSettings401Response
{
"type": "object",
"title": "unathorizedResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"errorCode": {
"type": "integer",
"description": "The response error code"
}
}
}
UserSettingsListAuthorizedSettingsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"beta_app": {
"type": "boolean",
"description": "Whether beta app is enabled"
},
"list_limit": {
"type": "number",
"description": "The number of results shown in list by default"
},
"marketplace_team": {
"type": "boolean",
"description": "If the vendors are allowed to be part of the Marketplace team or not"
},
"callto_link_syntax": {
"type": "string",
"description": "The call to link syntax"
},
"file_upload_destination": {
"type": "string",
"description": "The destination of file upload"
},
"person_duplicate_condition": {
"type": "string",
"description": "Allow the vendors to duplicate a person"
},
"autofill_deal_expected_close_date": {
"type": "boolean",
"description": "Whether the expected close date of the deal is filled automatically or not"
},
"marketplace_app_extensions_vendor": {
"type": "boolean",
"description": "If the vendors are allowed to extend their Marketplace apps with functionality and content in the Pipedrive UI or not"
},
"prevent_salesphone_callto_override": {
"type": "boolean",
"description": "Prevent salesphone call to override"
},
"marketplace_allow_custom_install_url": {
"type": "boolean",
"description": "If the vendors are allowed to install custom Marketplace apps with functionality and content in the Pipedrive UI or not"
}
}
}
}
}
],
"title": "getUserSettingsResponse200"
}
UsersAddNewUser403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
UsersAddNewUserRequest
{
"type": "object",
"title": "addUserRequest",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email of the user"
},
"access": {
"type": "array",
"items": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
},
"default": [
{
"app": "sales"
}
],
"description": "The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `[{ app: 'sales', permission_set_id: '62cc4d7f-4038-4352-abf3-a8c1c822b631' }, { app: 'global', admin: true }, { app: 'account_settings' }]`\n"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether the user is active or not. `false` = Not activated, `true` = Activated"
}
}
}
UsersAddNewUserResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
}
}
}
],
"title": "userResponse200"
}
UsersFindByNameResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
}
}
}
}
],
"title": "usersResponse200"
}
UsersGetAllResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
}
}
}
}
],
"title": "usersResponse200"
}
UsersGetCurrentUserData401Response
{
"type": "object",
"title": "unathorizedResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"errorCode": {
"type": "integer",
"description": "The response error code"
}
}
}
UsersGetCurrentUserDataResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
},
{
"type": "object",
"properties": {
"language": {
"type": "object",
"properties": {
"country_code": {
"type": "string",
"description": "The country code. E.g. US"
},
"language_code": {
"type": "string",
"description": "The language code. E.g. en"
}
},
"description": "The user language details"
},
"company_id": {
"type": "integer",
"description": "The user company ID"
},
"company_name": {
"type": "string",
"description": "The user company name"
},
"company_domain": {
"type": "string",
"description": "The user company domain"
},
"company_country": {
"type": "string",
"description": "The user company country"
},
"company_industry": {
"type": "string",
"description": "The user company industry"
}
}
}
]
}
}
}
],
"title": "getCurrentUserResponse200"
}
UsersGetUser404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
UsersGetUserResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
}
}
}
],
"title": "userResponse200"
}
UsersListFollowers403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}