{"openapi":"3.1.0","info":{"title":"CRM","version":"1.0.0"},"paths":{"/crm/v1/accounts":{"get":{"operationId":"accounts_list","summary":"List","description":"Returns a list of `Account` objects.{/* BEGIN_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountsGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"name","in":"query","description":"If provided, will only return accounts with this name.","required":false,"schema":{"type":"string"}},{"name":"owner_id","in":"query","description":"If provided, will only return accounts with this owner.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAccountList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"accounts_create","summary":"Create","description":"Creates an `Account` object with the given values.{/* BEGIN_CRM_ACCOUNT_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_CREATE_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMAccountEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/accounts/{id}":{"get":{"operationId":"accounts_retrieve","summary":"Retrieve","description":"Returns an `Account` object with the given `id`.{/* BEGIN_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountsIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"security":[{"tokenAuth":[]}]},"patch":{"operationId":"accounts_partialUpdate","summary":"Partial Update","description":"Updates an `Account` object with the given `id`.{/* BEGIN_CRM_ACCOUNT_EDIT_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_EDIT_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedCRMAccountEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/accounts/meta/patch/{id}":{"get":{"operationId":"accounts_metaPatchRetrieve","summary":"Meta Patch Retrieve","description":"Returns metadata for `CRMAccount` PATCHs.{/* BEGIN_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/accounts/meta/post":{"get":{"operationId":"accounts_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `CRMAccount` POSTs.{/* BEGIN_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/accounts/remote-field-classes":{"get":{"operationId":"accounts_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ACCOUNT_FETCH_SUPPORTED_FIELDS */}","tags":["accounts"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts":{"get":{"operationId":"contacts_list","summary":"List","description":"Returns a list of `Contact` objects.{/* BEGIN_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"account_id","in":"query","description":"If provided, will only return contacts with this account.","required":false,"schema":{"type":"string"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"email_addresses","in":"query","description":"If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactsGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"phone_numbers","in":"query","description":"If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.","required":false,"schema":{"type":"string"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContactList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"contacts_create","summary":"Create","description":"Creates a `Contact` object with the given values.{/* BEGIN_CRM_CONTACT_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_CREATE_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMContactResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMContactEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts/{id}":{"get":{"operationId":"contacts_retrieve","summary":"Retrieve","description":"Returns a `Contact` object with the given `id`.{/* BEGIN_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactsIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"security":[{"tokenAuth":[]}]},"patch":{"operationId":"contacts_partialUpdate","summary":"Partial Update","description":"Updates a `Contact` object with the given `id`.{/* BEGIN_CRM_CONTACT_EDIT_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_EDIT_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMContactResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedCRMContactEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts/ignore/{model_id}":{"post":{"operationId":"contacts_ignoreCreate","summary":"Ignore Create","description":"Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.{/* BEGIN_CRM_CONTACT_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_CREATE_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_ignoreCreate_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IgnoreCommonModelRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts/meta/patch/{id}":{"get":{"operationId":"contacts_metaPatchRetrieve","summary":"Meta Patch Retrieve","description":"Returns metadata for `CRMContact` PATCHs.{/* BEGIN_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts/meta/post":{"get":{"operationId":"contacts_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `CRMContact` POSTs.{/* BEGIN_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/contacts/remote-field-classes":{"get":{"operationId":"contacts_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CONTACT_FETCH_SUPPORTED_FIELDS */}","tags":["contacts"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagement-types":{"get":{"operationId":"engagementTypes_list","summary":"List","description":"Returns a list of `EngagementType` objects.{/* BEGIN_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}","tags":["engagementTypes"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedEngagementTypeList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagement-types/{id}":{"get":{"operationId":"engagementTypes_retrieve","summary":"Retrieve","description":"Returns an `EngagementType` object with the given `id`.{/* BEGIN_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}","tags":["engagementTypes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementType"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagement-types/remote-field-classes":{"get":{"operationId":"engagementTypes_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENTTYPE_FETCH_SUPPORTED_FIELDS */}","tags":["engagementTypes"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagements":{"get":{"operationId":"engagements_list","summary":"List","description":"Returns a list of `Engagement` objects.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/EngagementsGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"started_after","in":"query","description":"If provided, will only return engagements started after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"started_before","in":"query","description":"If provided, will only return engagements started before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedEngagementList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"engagements_create","summary":"Create","description":"Creates an `Engagement` object with the given values.{/* BEGIN_CRM_ENGAGEMENT_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_CREATE_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagements/{id}":{"get":{"operationId":"engagements_retrieve","summary":"Retrieve","description":"Returns an `Engagement` object with the given `id`.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/EngagementsIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Engagement"}}}}},"security":[{"tokenAuth":[]}]},"patch":{"operationId":"engagements_partialUpdate","summary":"Partial Update","description":"Updates an `Engagement` object with the given `id`.{/* BEGIN_CRM_ENGAGEMENT_EDIT_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_EDIT_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedEngagementEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagements/meta/patch/{id}":{"get":{"operationId":"engagements_metaPatchRetrieve","summary":"Meta Patch Retrieve","description":"Returns metadata for `Engagement` PATCHs.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagements/meta/post":{"get":{"operationId":"engagements_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `Engagement` POSTs.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/engagements/remote-field-classes":{"get":{"operationId":"engagements_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}","tags":["engagements"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/leads":{"get":{"operationId":"leads_list","summary":"List","description":"Returns a list of `Lead` objects.{/* BEGIN_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}","tags":["leads"],"parameters":[{"name":"converted_account_id","in":"query","description":"If provided, will only return leads with this account.","required":false,"schema":{"type":"string"}},{"name":"converted_contact_id","in":"query","description":"If provided, will only return leads with this contact.","required":false,"schema":{"type":"string"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"email_addresses","in":"query","description":"If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeadsGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"owner_id","in":"query","description":"If provided, will only return leads with this owner.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"phone_numbers","in":"query","description":"If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.","required":false,"schema":{"type":"string"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLeadList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"leads_create","summary":"Create","description":"Creates a `Lead` object with the given values.{/* BEGIN_CRM_LEAD_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_LEAD_CREATE_SUPPORTED_FIELDS */}","tags":["leads"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/leads/{id}":{"get":{"operationId":"leads_retrieve","summary":"Retrieve","description":"Returns a `Lead` object with the given `id`.{/* BEGIN_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeadsIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/leads/meta/post":{"get":{"operationId":"leads_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `Lead` POSTs.{/* BEGIN_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}","tags":["leads"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/leads/remote-field-classes":{"get":{"operationId":"leads_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}","tags":["leads"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/notes":{"get":{"operationId":"notes_list","summary":"List","description":"Returns a list of `Note` objects.{/* BEGIN_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}","tags":["notes"],"parameters":[{"name":"account_id","in":"query","description":"If provided, will only return notes with this account.","required":false,"schema":{"type":"string"}},{"name":"contact_id","in":"query","description":"If provided, will only return notes with this contact.","required":false,"schema":{"type":"string"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotesGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"opportunity_id","in":"query","description":"If provided, will only return notes with this opportunity.","required":false,"schema":{"type":"string"}},{"name":"owner_id","in":"query","description":"If provided, will only return notes with this owner.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedNoteList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"notes_create","summary":"Create","description":"Creates a `Note` object with the given values.{/* BEGIN_CRM_NOTE_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_NOTE_CREATE_SUPPORTED_FIELDS */}","tags":["notes"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/notes/{id}":{"get":{"operationId":"notes_retrieve","summary":"Retrieve","description":"Returns a `Note` object with the given `id`.{/* BEGIN_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}","tags":["notes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotesIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/notes/meta/post":{"get":{"operationId":"notes_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `Note` POSTs.{/* BEGIN_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}","tags":["notes"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/notes/remote-field-classes":{"get":{"operationId":"notes_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_NOTE_FETCH_SUPPORTED_FIELDS */}","tags":["notes"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/opportunities":{"get":{"operationId":"opportunities_list","summary":"List","description":"Returns a list of `Opportunity` objects.{/* BEGIN_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"account_id","in":"query","description":"If provided, will only return opportunities with this account.","required":false,"schema":{"type":"string"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpportunitiesGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"owner_id","in":"query","description":"If provided, will only return opportunities with this owner.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_created_after","in":"query","description":"If provided, will only return opportunities created in the third party platform after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"remote_fields","in":"query","description":"Deprecated. Use show_enum_origins.","required":false,"schema":{"$ref":"#/components/schemas/OpportunitiesGetParametersRemoteFields"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"show_enum_origins","in":"query","description":"A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)","required":false,"schema":{"$ref":"#/components/schemas/OpportunitiesGetParametersShowEnumOrigins"}},{"name":"stage_id","in":"query","description":"If provided, will only return opportunities with this stage.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')\n\n","required":false,"schema":{"$ref":"#/components/schemas/OpportunitiesGetParametersStatus"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOpportunityList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"opportunities_create","summary":"Create","description":"Creates an `Opportunity` object with the given values.{/* BEGIN_CRM_OPPORTUNITY_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_CREATE_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/opportunities/{id}":{"get":{"operationId":"opportunities_retrieve","summary":"Retrieve","description":"Returns an `Opportunity` object with the given `id`.{/* BEGIN_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpportunitiesIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"remote_fields","in":"query","description":"Deprecated. Use show_enum_origins.","required":false,"schema":{"$ref":"#/components/schemas/OpportunitiesIdGetParametersRemoteFields"}},{"name":"show_enum_origins","in":"query","description":"A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)","required":false,"schema":{"$ref":"#/components/schemas/OpportunitiesIdGetParametersShowEnumOrigins"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}}},"security":[{"tokenAuth":[]}]},"patch":{"operationId":"opportunities_partialUpdate","summary":"Partial Update","description":"Updates an `Opportunity` object with the given `id`.{/* BEGIN_CRM_OPPORTUNITY_EDIT_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_EDIT_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedOpportunityEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/opportunities/meta/patch/{id}":{"get":{"operationId":"opportunities_metaPatchRetrieve","summary":"Meta Patch Retrieve","description":"Returns metadata for `Opportunity` PATCHs.{/* BEGIN_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/opportunities/meta/post":{"get":{"operationId":"opportunities_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `Opportunity` POSTs.{/* BEGIN_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/opportunities/remote-field-classes":{"get":{"operationId":"opportunities_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_OPPORTUNITY_FETCH_SUPPORTED_FIELDS */}","tags":["opportunities"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/stages":{"get":{"operationId":"stages_list","summary":"List","description":"Returns a list of `Stage` objects.{/* BEGIN_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}","tags":["stages"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedStageList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/stages/{id}":{"get":{"operationId":"stages_retrieve","summary":"Retrieve","description":"Returns a `Stage` object with the given `id`.{/* BEGIN_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}","tags":["stages"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stage"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/stages/remote-field-classes":{"get":{"operationId":"stages_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_STAGE_FETCH_SUPPORTED_FIELDS */}","tags":["stages"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/tasks":{"get":{"operationId":"tasks_list","summary":"List","description":"Returns a list of `Task` objects.{/* BEGIN_CRM_TASK_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_TASK_FETCH_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TasksGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTaskList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"tasks_create","summary":"Create","description":"Creates a `Task` object with the given values.{/* BEGIN_CRM_TASK_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_TASK_CREATE_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/tasks/{id}":{"get":{"operationId":"tasks_retrieve","summary":"Retrieve","description":"Returns a `Task` object with the given `id`.{/* BEGIN_CRM_TASK_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_TASK_FETCH_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TasksIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/tasks/meta/patch/{id}":{"get":{"operationId":"tasks_metaPatchRetrieve","summary":"Meta Patch Retrieve","description":"Returns metadata for `Task` PATCHs.{/* BEGIN_CRM_TASK_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_TASK_FETCH_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/tasks/meta/post":{"get":{"operationId":"tasks_metaPostRetrieve","summary":"Meta Post Retrieve","description":"Returns metadata for `Task` POSTs.{/* BEGIN_CRM_TASK_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_TASK_FETCH_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/tasks/remote-field-classes":{"get":{"operationId":"tasks_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_TASK_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_TASK_FETCH_SUPPORTED_FIELDS */}","tags":["tasks"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/users":{"get":{"operationId":"users_list","summary":"List","description":"Returns a list of `User` objects.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}","tags":["users"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"If provided, will only return users with this email.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedUserList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/users/{id}":{"get":{"operationId":"users_retrieve","summary":"Retrieve","description":"Returns a `User` object with the given `id`.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}","tags":["users"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/users/ignore/{model_id}":{"post":{"operationId":"users_ignoreCreate","summary":"Ignore Create","description":"Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.{/* BEGIN_CRM_USER_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_USER_CREATE_SUPPORTED_FIELDS */}","tags":["users"],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_ignoreCreate_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IgnoreCommonModelRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/users/remote-field-classes":{"get":{"operationId":"users_remoteFieldClassesList","summary":"Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}","tags":["users"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes":{"get":{"operationId":"customObjectClasses_list","summary":"List","description":"Returns a list of `CustomObjectClass` objects.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjectClasses"],"parameters":[{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClassesGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCustomObjectClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{id}":{"get":{"operationId":"customObjectClasses_retrieve","summary":"Retrieve","description":"Returns a `CustomObjectClass` object with the given `id`.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjectClasses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClassesIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectClass"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects":{"get":{"operationId":"customObjects_custom_object_classes_custom_objects_list","summary":"Custom Object Classes Custom Objects List","description":"Returns a list of `CustomObject` objects.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjects"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCustomObjectList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"customObjects_custom_object_classes_custom_objects_create","summary":"Custom Object Classes Custom Objects Create","description":"Creates a `CustomObject` object with the given values.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_CREATE_SUPPORTED_FIELDS */}","tags":["customObjects"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMCustomObjectResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMCustomObjectEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{id}":{"get":{"operationId":"customObjects_custom_object_classes_custom_objects_retrieve","summary":"Custom Object Classes Custom Objects Retrieve","description":"Returns a `CustomObject` object with the given `id`.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjects"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObject"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post":{"get":{"operationId":"customObjects_custom_object_classes_custom_objects_meta_post_retrieve","summary":"Custom Object Classes Custom Objects Meta Post Retrieve","description":"Returns metadata for `CRMCustomObject` POSTs.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjects"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/custom-objects/remote-field-classes":{"get":{"operationId":"customObjects_custom_object_classes_custom_objects_remote_field_classes_list","summary":"Custom Object Classes Custom Objects Remote Field Classes List","description":"Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["customObjects"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_fields","in":"query","description":"Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"is_common_model_field","in":"query","description":"If provided, will only return remote field classes with this is_common_model_field value","required":false,"schema":{"type":"boolean"}},{"name":"is_custom","in":"query","description":"If provided, will only return remote fields classes with this is_custom value","required":false,"schema":{"type":"boolean"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRemoteFieldClassList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/association-types":{"get":{"operationId":"associationTypes_custom_object_classes_association_types_list","summary":"Custom Object Classes Association Types List","description":"Returns a list of `AssociationType` objects.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["associationTypes"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClassesCustomObjectClassIdAssociationTypesGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAssociationTypeList"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"associationTypes_custom_object_classes_association_types_create","summary":"Custom Object Classes Association Types Create","description":"Creates an `AssociationType` object with the given values.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_CREATE_SUPPORTED_FIELDS */}","tags":["associationTypes"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMAssociationTypeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRMAssociationTypeEndpointRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}":{"get":{"operationId":"associationTypes_custom_object_classes_association_types_retrieve","summary":"Custom Object Classes Association Types Retrieve","description":"Returns an `AssociationType` object with the given `id`.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["associationTypes"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClassesCustomObjectClassIdAssociationTypesIdGetParametersExpandSchemaItems"}}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociationType"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post":{"get":{"operationId":"associationTypes_custom_object_classes_association_types_meta_post_retrieve","summary":"Custom Object Classes Association Types Meta Post Retrieve","description":"Returns metadata for `CRMAssociationType` POSTs.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["associationTypes"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations":{"get":{"operationId":"associations_custom_object_classes_custom_objects_associations_list","summary":"Custom Object Classes Custom Objects Associations List","description":"Returns a list of `Association` objects.{/* BEGIN_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}{/* END_CRM_CUSTOMOBJECTCLASS_FETCH_SUPPORTED_FIELDS */}","tags":["associations"],"parameters":[{"name":"custom_object_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"object_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"association_type_id","in":"query","description":"If provided, will only return opportunities with this association_type.","required":false,"schema":{"type":"string"}},{"name":"created_after","in":"query","description":"If provided, will only return objects created after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","description":"If provided, will only return objects created before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClassesCustomObjectClassIdCustomObjectsObjectIdAssociationsGetParametersExpandSchemaItems"}}},{"name":"include_deleted_data","in":"query","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).","required":false,"schema":{"type":"boolean"}},{"name":"include_remote_data","in":"query","description":"Whether to include the original data Merge fetched from the third-party to produce these models.","required":false,"schema":{"type":"boolean"}},{"name":"include_shell_data","in":"query","description":"Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).","required":false,"schema":{"type":"boolean"}},{"name":"modified_after","in":"query","description":"If provided, only objects synced by Merge after this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"modified_before","in":"query","description":"If provided, only objects synced by Merge before this date time will be returned.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"remote_id","in":"query","description":"The API provider's ID for the given object.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAssociationList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}":{"put":{"operationId":"associations_custom_object_classes_custom_objects_associations_update","summary":"Custom Object Classes Custom Objects Associations Update","description":"Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.","tags":["associations"],"parameters":[{"name":"association_type_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"source_class_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"source_object_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"target_class_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"target_object_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_debug_mode","in":"query","description":"Whether to include debug fields (such as log file links) in the response.","required":false,"schema":{"type":"boolean"}},{"name":"run_async","in":"query","description":"Whether or not third-party updates should be run asynchronously.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Association"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/account-details":{"get":{"operationId":"accountDetails_retrieve","summary":"Retrieve","description":"Get details for a linked account.","tags":["accountDetails"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetails"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/account-token/{public_token}":{"get":{"operationId":"accountToken_retrieve","summary":"Retrieve","description":"Returns the account token for the end user with the provided public token.","tags":["accountToken"],"parameters":[{"name":"public_token","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountToken"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/account-token/regenerate":{"post":{"operationId":"accountToken_regenerateCreate","summary":"Regenerate Create","description":"Exchange Linked Account account tokens.","tags":["accountToken"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegenerateAccountToken"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/delete-account":{"post":{"operationId":"deleteAccount_delete","summary":"Delete","description":"Delete a linked account.","tags":["deleteAccount"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteAccount_delete_Response_200"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/issues":{"get":{"operationId":"issues_list","summary":"List","description":"Gets all issues for Organization.","tags":["issues"],"parameters":[{"name":"account_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"If included, will only include issues whose most recent action occurred before this time","required":false,"schema":{"type":"string"}},{"name":"end_user_organization_name","in":"query","required":false,"schema":{"type":"string"}},{"name":"first_incident_time_after","in":"query","description":"If provided, will only return issues whose first incident time was after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"first_incident_time_before","in":"query","description":"If provided, will only return issues whose first incident time was before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"include_muted","in":"query","description":"If true, will include muted issues","required":false,"schema":{"type":"string"}},{"name":"integration_name","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_incident_time_after","in":"query","description":"If provided, will only return issues whose last incident time was after this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"last_incident_time_before","in":"query","description":"If provided, will only return issues whose last incident time was before this datetime.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"linked_account_id","in":"query","description":"If provided, will only include issues pertaining to the linked account passed in.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"If included, will only include issues whose most recent action occurred after this time","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of the issue.","required":false,"schema":{"$ref":"#/components/schemas/IssuesGetParametersStatus"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedIssueList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/issues/{id}":{"get":{"operationId":"issues_retrieve","summary":"Retrieve","description":"Get a specific issue.","tags":["issues"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Issue"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/linked-accounts":{"get":{"operationId":"linkedAccounts_list","summary":"List","description":"List linked accounts for your organization.","tags":["linkedAccounts"],"parameters":[{"name":"category","in":"query","description":"Options: `hris`, `ats`, `accounting`, `ticketing`, `crm`, `mktg`, `filestorage`, `knowledgebase`, `chat`","required":false,"schema":{"$ref":"#/components/schemas/LinkedAccountsGetParametersCategory"}},{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"end_user_email_address","in":"query","description":"If provided, will only return linked accounts associated with the given email address.","required":false,"schema":{"type":"string"}},{"name":"end_user_organization_name","in":"query","description":"If provided, will only return linked accounts associated with the given organization name.","required":false,"schema":{"type":"string"}},{"name":"end_user_origin_id","in":"query","description":"If provided, will only return linked accounts associated with the given origin ID.","required":false,"schema":{"type":"string"}},{"name":"end_user_origin_ids","in":"query","description":"Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"ids","in":"query","description":"Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.","required":false,"schema":{"type":"string"}},{"name":"include_duplicates","in":"query","description":"If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.","required":false,"schema":{"type":"boolean"}},{"name":"integration_name","in":"query","description":"If provided, will only return linked accounts associated with the given integration name.","required":false,"schema":{"type":"string"}},{"name":"is_test_account","in":"query","description":"If included, will only include test linked accounts. If not included, will only include non-test linked accounts.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"status","in":"query","description":"Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAccountDetailsAndActionsList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/link-token":{"post":{"operationId":"linkToken_create","summary":"Create","description":"Creates a link token to be used when linking a new end user. The link token expires after single use.","tags":["linkToken"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkToken"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndUserDetailsRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/field-mappings":{"get":{"operationId":"fieldMapping_field_mappings_retrieve","summary":"Field Mappings Retrieve","description":"Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).","tags":["fieldMapping"],"parameters":[{"name":"exclude_remote_field_metadata","in":"query","description":"If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.","required":false,"schema":{"type":"boolean"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMappingApiInstanceResponse"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"fieldMapping_field_mappings_create","summary":"Field Mappings Create","description":"Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.","tags":["fieldMapping"],"parameters":[{"name":"exclude_remote_field_metadata","in":"query","description":"If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.","required":false,"schema":{"type":"boolean"}},{"name":"remote_data_iteration_count","in":"query","description":"Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMappingInstanceResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFieldMappingRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/field-mappings/{field_mapping_id}":{"delete":{"operationId":"fieldMapping_field_mappings_destroy","summary":"Field Mappings Destroy","description":"Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.","tags":["fieldMapping"],"parameters":[{"name":"field_mapping_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMappingInstanceResponse"}}}}},"security":[{"tokenAuth":[]}]},"patch":{"operationId":"fieldMapping_field_mappings_partial_update","summary":"Field Mappings Partial Update","description":"Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.","tags":["fieldMapping"],"parameters":[{"name":"field_mapping_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"remote_data_iteration_count","in":"query","description":"Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMappingInstanceResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedEditFieldMappingRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/remote-fields":{"get":{"operationId":"fieldMapping_remote_fields_retrieve","summary":"Remote Fields Retrieve","description":"Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).","tags":["fieldMapping"],"parameters":[{"name":"common_models","in":"query","description":"A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.","required":false,"schema":{"type":"string"}},{"name":"include_example_values","in":"query","description":"If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.","required":false,"schema":{"type":"string"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteFieldAPIResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/target-fields":{"get":{"operationId":"fieldMapping_target_fields_retrieve","summary":"Target Fields Retrieve","description":"Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).","tags":["fieldMapping"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalTargetFieldAPIResponse"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"fieldMapping_target_fields_create","summary":"Target Fields Create","description":"Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).","tags":["fieldMapping"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalTargetFieldAPIResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetFieldRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/available-actions":{"get":{"operationId":"availableActions_retrieve","summary":"Retrieve","description":"Returns a list of models and actions available for an account.","tags":["availableActions"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableActions"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/default-scopes":{"get":{"operationId":"scopes_default_scopes_retrieve","summary":"Default Scopes Retrieve","description":"Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).","tags":["scopes"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonModelScopeAPI"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/linked-account-scopes":{"get":{"operationId":"scopes_linked_account_scopes_retrieve","summary":"Linked Account Scopes Retrieve","description":"Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).","tags":["scopes"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonModelScopeAPI"}}}}},"security":[{"tokenAuth":[]}]},"post":{"operationId":"scopes_linked_account_scopes_create","summary":"Linked Account Scopes Create","description":"Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)","tags":["scopes"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonModelScopeAPI"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/sync-status/resync":{"post":{"operationId":"forceResync_sync_status_resync_create","summary":"Sync Status Resync Create","description":"Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.","tags":["forceResync"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SyncStatus"}}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/passthrough":{"post":{"operationId":"passthrough_create","summary":"Create","description":"Pull data from an endpoint not currently supported by Merge.","tags":["passthrough"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPassthroughRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/async-passthrough":{"post":{"operationId":"asyncPassthrough_create","summary":"Create","description":"Asynchronously pull data from an endpoint not currently supported by Merge.","tags":["asyncPassthrough"],"parameters":[{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncPassthroughReciept"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPassthroughRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/async-passthrough/{async_passthrough_receipt_id}":{"get":{"operationId":"asyncPassthrough_retrieve","summary":"Retrieve","description":"Retrieves data from earlier async-passthrough POST request","tags":["asyncPassthrough"],"parameters":[{"name":"async_passthrough_receipt_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteResponse"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/sync-status":{"get":{"operationId":"syncStatus_list","summary":"List","description":"Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).","tags":["syncStatus"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"X-Account-Token","in":"header","description":"Token identifying the end user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSyncStatusList"}}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/generate-key":{"post":{"operationId":"generateKey_create","summary":"Create","description":"Create a remote key.","tags":["generateKey"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRemoteKeyRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/regenerate-key":{"post":{"operationId":"regenerateKey_create","summary":"Create","description":"Exchange remote keys.","tags":["regenerateKey"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteKeyForRegenerationRequest"}}}},"security":[{"tokenAuth":[]}]}},"/crm/v1/audit-trail":{"get":{"operationId":"auditTrail_list","summary":"List","description":"Gets a list of audit trail events.","tags":["auditTrail"],"parameters":[{"name":"cursor","in":"query","description":"The pagination cursor value.","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"If included, will only include audit trail events that occurred before this time","required":false,"schema":{"type":"string"}},{"name":"event_type","in":"query","description":"If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`, `CHANGED_SELECTIVE_SYNC_FILTERS`, `ADDED_PARTNER_CREDENTIALS`, `UPDATED_PARTNER_CREDENTIALS`, `REMOVED_PARTNER_CREDENTIALS`","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"Number of results to return per page. The maximum limit is 100.","required":false,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"If included, will only include audit trail events that occurred after this time","required":false,"schema":{"type":"string"}},{"name":"user_email","in":"query","description":"If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAuditLogEventList"}}}}},"security":[{"tokenAuth":[]}]}}},"tags":[{"name":"accounts"},{"name":"contacts"},{"name":"engagementTypes"},{"name":"engagements"},{"name":"leads"},{"name":"notes"},{"name":"opportunities"},{"name":"stages"},{"name":"tasks"},{"name":"users"},{"name":"customObjectClasses"},{"name":"customObjects"},{"name":"associationTypes"},{"name":"associations"},{"name":"accountDetails"},{"name":"accountToken"},{"name":"deleteAccount"},{"name":"issues"},{"name":"linkedAccounts"},{"name":"linkToken"},{"name":"fieldMapping"},{"name":"availableActions"},{"name":"scopes"},{"name":"forceResync"},{"name":"passthrough"},{"name":"asyncPassthrough"},{"name":"syncStatus"},{"name":"generateKey"},{"name":"regenerateKey"},{"name":"auditTrail"}],"servers":[{"url":"https://api.merge.dev/api","description":"Production"},{"url":"https://api-eu.merge.dev/api","description":"ProductionEU"},{"url":"https://api-ap.merge.dev/api","description":"ProductionAPSE1"}],"components":{"schemas":{"AccountsGetParametersExpandSchemaItems":{"type":"string","enum":["owner"],"title":"AccountsGetParametersExpandSchemaItems"},"CountryEnum":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"The country code in ISO 3166-1 alpha-2 format.","title":"CountryEnum"},"AddressTypeEnum":{"type":"string","enum":["BILLING","SHIPPING"],"title":"AddressTypeEnum"},"Address":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"street_1":{"type":["string","null"],"description":"Line 1 of the address's street."},"street_2":{"type":["string","null"],"description":"Line 2 of the address's street."},"city":{"type":["string","null"],"description":"The address's city."},"state":{"type":["string","null"],"description":"The address's state."},"postal_code":{"type":["string","null"],"description":"The address's postal code."},"country":{"oneOf":[{"$ref":"#/components/schemas/CountryEnum"},{"type":"null"}],"description":"The address's country. The country code in ISO 3166-1 alpha-2 format."},"address_type":{"oneOf":[{"$ref":"#/components/schemas/AddressTypeEnum"},{"type":"null"}],"description":"The address type."}},"description":"# The Address Object\n### Description\nThe `Address` object is used to represent an entity's address.\n### Usage Example\nTODO","title":"Address"},"PhoneNumber":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"phone_number":{"type":["string","null"],"description":"The phone number."},"phone_number_type":{"type":["string","null"],"description":"The phone number's type."}},"description":"# The PhoneNumber Object\n### Description\nThe `PhoneNumber` object is used to represent an entity's phone number.\n### Usage Example\nFetch from the `GET Contact` endpoint and view their phone numbers.","title":"PhoneNumber"},"AccountFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"AccountFieldMappings"},"RemoteData":{"type":"object","properties":{"path":{"type":"string","description":"The third-party API path that is being called."},"data":{"description":"The data returned from the third-party for this object in its original, unnormalized format."}},"required":["path"],"description":"# The RemoteData Object\n### Description\nThe `RemoteData` object is used to represent the full data pulled from the third-party API for an object.\n\n### Usage Example\nTODO","title":"RemoteData"},"FieldTypeEnum":{"type":"string","enum":["string","number","date","datetime","bool","list"],"title":"FieldTypeEnum"},"FieldFormatEnum":{"type":"string","enum":["string","number","date","datetime","bool","list"],"title":"FieldFormatEnum"},"ItemTypeEnum":{"type":"string","enum":["string","number","date","datetime","bool","list"],"title":"ItemTypeEnum"},"ItemFormatEnum":{"type":"string","enum":["string","number","date","datetime","bool","list"],"title":"ItemFormatEnum"},"ItemSchema":{"type":"object","properties":{"item_type":{"$ref":"#/components/schemas/ItemTypeEnum"},"item_format":{"$ref":"#/components/schemas/ItemFormatEnum"},"item_choices":{"type":"array","items":{"type":"string"}}},"title":"ItemSchema"},"RemoteFieldClass":{"type":"object","properties":{"id":{"type":"string"},"display_name":{"type":"string"},"remote_key_name":{"type":"string"},"description":{"type":"string"},"is_custom":{"type":"boolean"},"is_common_model_field":{"type":"boolean"},"is_required":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"field_format":{"$ref":"#/components/schemas/FieldFormatEnum"},"field_choices":{"type":"array","items":{"type":"string"}},"item_schema":{"$ref":"#/components/schemas/ItemSchema"}},"title":"RemoteFieldClass"},"RemoteField":{"type":"object","properties":{"remote_field_class":{"$ref":"#/components/schemas/RemoteFieldClass"},"value":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["remote_field_class"],"title":"RemoteField"},"Account":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"owner":{"type":["string","null"],"format":"uuid","description":"The account's owner."},"name":{"type":["string","null"],"description":"The account's name."},"description":{"type":["string","null"],"description":"The account's description."},"industry":{"type":["string","null"],"description":"The account's industry."},"website":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's website."},"number_of_employees":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The account's number of employees."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"The last date (either most recent or furthest in the future) of when an activity occurs in an account."},"remote_updated_at":{"type":["string","null"],"format":"date-time","description":"When the CRM system account data was last modified by a user with a login."},"remote_created_at":{"type":["string","null"],"format":"date-time","description":"When the third party's account was created."},"account_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/AccountFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Account Object\n### Description\nThe `Account` object is used to represent a company in a CRM system.\n### Usage Example\nTODO","title":"Account"},"PaginatedAccountList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}},"title":"PaginatedAccountList"},"AddressRequest":{"type":"object","properties":{"street_1":{"type":["string","null"],"description":"Line 1 of the address's street."},"street_2":{"type":["string","null"],"description":"Line 2 of the address's street."},"city":{"type":["string","null"],"description":"The address's city."},"state":{"type":["string","null"],"description":"The address's state."},"postal_code":{"type":["string","null"],"description":"The address's postal code."},"country":{"oneOf":[{"$ref":"#/components/schemas/CountryEnum"},{"type":"null"}],"description":"The address's country. The country code in ISO 3166-1 alpha-2 format."},"address_type":{"oneOf":[{"$ref":"#/components/schemas/AddressTypeEnum"},{"type":"null"}],"description":"The address type."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"description":"# The Address Object\n### Description\nThe `Address` object is used to represent an entity's address.\n### Usage Example\nTODO","title":"AddressRequest"},"RemoteFieldRequest":{"type":"object","properties":{"remote_field_class":{"type":"string","format":"uuid"},"value":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["remote_field_class"],"title":"RemoteFieldRequest"},"AccountRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The account's owner."},"name":{"type":["string","null"],"description":"The account's name."},"description":{"type":["string","null"],"description":"The account's description."},"industry":{"type":["string","null"],"description":"The account's industry."},"website":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's website."},"number_of_employees":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The account's number of employees."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequest"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"The last date (either most recent or furthest in the future) of when an activity occurs in an account."},"account_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Account Object\n### Description\nThe `Account` object is used to represent a company in a CRM system.\n### Usage Example\nTODO","title":"AccountRequest"},"CRMAccountEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/AccountRequest"}},"required":["model"],"title":"CRMAccountEndpointRequest"},"ValidationProblemSource":{"type":"object","properties":{"pointer":{"type":"string"}},"required":["pointer"],"title":"ValidationProblemSource"},"WarningValidationProblem":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/ValidationProblemSource"},"title":{"type":"string"},"detail":{"type":"string"},"problem_type":{"type":"string"},"block_merge_link":{"type":"boolean"},"raw_error":{"type":"string"},"error_code":{"type":"integer"}},"required":["title","detail","problem_type"],"title":"WarningValidationProblem"},"ErrorValidationProblem":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/ValidationProblemSource"},"title":{"type":"string"},"detail":{"type":"string"},"problem_type":{"type":"string"},"block_merge_link":{"type":"boolean"},"raw_error":{"type":"string"},"error_code":{"type":"integer"}},"required":["title","detail","problem_type"],"title":"ErrorValidationProblem"},"DebugModelLogSummary":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"status_code":{"type":"integer"}},"required":["url","method","status_code"],"title":"DebugModelLogSummary"},"DebugModeLog":{"type":"object","properties":{"log_id":{"type":"string"},"dashboard_view":{"type":"string"},"log_summary":{"$ref":"#/components/schemas/DebugModelLogSummary"}},"required":["log_id","dashboard_view","log_summary"],"title":"DebugModeLog"},"CRMAccountResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Account"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"CRMAccountResponse"},"AccountsIdGetParametersExpandSchemaItems":{"type":"string","enum":["owner"],"title":"AccountsIdGetParametersExpandSchemaItems"},"PatchedAccountRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The account's owner."},"name":{"type":["string","null"],"description":"The account's name."},"description":{"type":["string","null"],"description":"The account's description."},"industry":{"type":["string","null"],"description":"The account's industry."},"website":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's website."},"number_of_employees":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The account's number of employees."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequest"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"The last date (either most recent or furthest in the future) of when an activity occurs in an account."},"account_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The account's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Account Object\n### Description\nThe `Account` object is used to represent a company in a CRM system.\n### Usage Example\nTODO","title":"PatchedAccountRequest"},"PatchedCRMAccountEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/PatchedAccountRequest"}},"required":["model"],"title":"PatchedCRMAccountEndpointRequest"},"LinkedAccountStatus":{"type":"object","properties":{"linked_account_status":{"type":"string"},"can_make_request":{"type":"boolean"}},"required":["linked_account_status","can_make_request"],"title":"LinkedAccountStatus"},"MetaResponse":{"type":"object","properties":{"request_schema":{"type":"object","additionalProperties":{"description":"Any type"}},"status":{"$ref":"#/components/schemas/LinkedAccountStatus"},"has_conditional_params":{"type":"boolean"},"has_required_linked_account_params":{"type":"boolean"},"remote_fields":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Remote field values to populate"}},"required":["request_schema","has_conditional_params","has_required_linked_account_params"],"title":"MetaResponse"},"PaginatedRemoteFieldClassList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldClass"}}},"title":"PaginatedRemoteFieldClassList"},"ContactsGetParametersExpandSchemaItems":{"type":"string","enum":["account","owner"],"title":"ContactsGetParametersExpandSchemaItems"},"EmailAddress":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"email_address":{"type":["string","null"],"description":"The email address."},"email_address_type":{"type":["string","null"],"description":"The email address's type."}},"description":"# The EmailAddress Object\n### Description\nThe `EmailAddress` object is used to represent an entity's email address.\n### Usage Example\nFetch from the `GET Contact` endpoint and view their email addresses.","title":"EmailAddress"},"ContactFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"ContactFieldMappings"},"Contact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"first_name":{"type":["string","null"],"description":"The contact's first name."},"last_name":{"type":["string","null"],"description":"The contact's last name."},"account":{"type":["string","null"],"format":"uuid","description":"The contact's account."},"owner":{"type":["string","null"],"format":"uuid","description":"The contact's owner."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the contact's last activity occurred."},"remote_created_at":{"type":["string","null"],"format":"date-time","description":"When the third party's contact was created."},"contact_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The contact's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/ContactFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Contact Object\n### Description\nThe `Contact` object is used to represent an existing point of contact at a company in a CRM system.\n### Usage Example\nTODO","title":"Contact"},"PaginatedContactList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}},"title":"PaginatedContactList"},"EmailAddressRequest":{"type":"object","properties":{"email_address":{"type":["string","null"],"description":"The email address."},"email_address_type":{"type":["string","null"],"description":"The email address's type."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"description":"# The EmailAddress Object\n### Description\nThe `EmailAddress` object is used to represent an entity's email address.\n### Usage Example\nFetch from the `GET Contact` endpoint and view their email addresses.","title":"EmailAddressRequest"},"PhoneNumberRequest":{"type":"object","properties":{"phone_number":{"type":["string","null"],"description":"The phone number."},"phone_number_type":{"type":["string","null"],"description":"The phone number's type."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"description":"# The PhoneNumber Object\n### Description\nThe `PhoneNumber` object is used to represent an entity's phone number.\n### Usage Example\nFetch from the `GET Contact` endpoint and view their phone numbers.","title":"PhoneNumberRequest"},"ContactRequest":{"type":"object","properties":{"first_name":{"type":["string","null"],"description":"The contact's first name."},"last_name":{"type":["string","null"],"description":"The contact's last name."},"account":{"type":["string","null"],"format":"uuid","description":"The contact's account."},"owner":{"type":["string","null"],"format":"uuid","description":"The contact's owner."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequest"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressRequest"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberRequest"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the contact's last activity occurred."},"contact_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The contact's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Contact Object\n### Description\nThe `Contact` object is used to represent an existing point of contact at a company in a CRM system.\n### Usage Example\nTODO","title":"ContactRequest"},"CRMContactEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/ContactRequest"}},"required":["model"],"title":"CRMContactEndpointRequest"},"CRMContactResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Contact"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"CRMContactResponse"},"ContactsIdGetParametersExpandSchemaItems":{"type":"string","enum":["account","owner"],"title":"ContactsIdGetParametersExpandSchemaItems"},"PatchedContactRequest":{"type":"object","properties":{"first_name":{"type":["string","null"],"description":"The contact's first name."},"last_name":{"type":["string","null"],"description":"The contact's last name."},"account":{"type":["string","null"],"format":"uuid","description":"The contact's account."},"owner":{"type":["string","null"],"format":"uuid","description":"The contact's owner."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequest"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressRequest"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberRequest"}},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the contact's last activity occurred."},"contact_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The contact's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Contact Object\n### Description\nThe `Contact` object is used to represent an existing point of contact at a company in a CRM system.\n### Usage Example\nTODO","title":"PatchedContactRequest"},"PatchedCRMContactEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/PatchedContactRequest"}},"required":["model"],"title":"PatchedCRMContactEndpointRequest"},"ReasonEnum":{"type":"string","enum":["GENERAL_CUSTOMER_REQUEST","GDPR","OTHER"],"title":"ReasonEnum"},"IgnoreCommonModelRequest":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/ReasonEnum"},"message":{"type":"string","minLength":1,"maxLength":256}},"required":["reason"],"title":"IgnoreCommonModelRequest"},"contacts_ignoreCreate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"contacts_ignoreCreate_Response_200"},"ActivityTypeEnum":{"type":"string","enum":["CALL","MEETING","EMAIL"],"title":"ActivityTypeEnum"},"EngagementType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"activity_type":{"oneOf":[{"$ref":"#/components/schemas/ActivityTypeEnum"},{"type":"null"}],"description":"The engagement type's activity type."},"name":{"type":["string","null"],"description":"The engagement type's name."},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Engagement Type Object\n### Description\nThe `Engagement Type` object is used to represent an interaction activity. A given `Engagement` typically has an `Engagement Type` object represented in the engagement_type field.\n### Usage Example\nTODO","title":"EngagementType"},"PaginatedEngagementTypeList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/EngagementType"}}},"title":"PaginatedEngagementTypeList"},"EngagementsGetParametersExpandSchemaItems":{"type":"string","enum":["account","contacts","engagement_type","owner"],"title":"EngagementsGetParametersExpandSchemaItems"},"DirectionEnum":{"type":"string","enum":["INBOUND","OUTBOUND"],"title":"DirectionEnum"},"EngagementFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"EngagementFieldMappings"},"Engagement":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"owner":{"type":["string","null"],"format":"uuid","description":"The engagement's owner."},"content":{"type":["string","null"],"description":"The engagement's content."},"subject":{"type":["string","null"],"description":"The engagement's subject."},"direction":{"oneOf":[{"$ref":"#/components/schemas/DirectionEnum"},{"type":"null"}],"description":"The engagement's direction."},"engagement_type":{"type":["string","null"],"format":"uuid","description":"The engagement type of the engagement."},"start_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement started."},"end_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement ended."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the engagement."},"contacts":{"type":"array","items":{"type":"string","format":"uuid"}},"engagement_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The engagement's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/EngagementFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Engagement Object\n### Description\nThe `Engagement` object is used to represent an interaction noted in a CRM system.\n### Usage Example\nTODO","title":"Engagement"},"PaginatedEngagementList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Engagement"}}},"title":"PaginatedEngagementList"},"EngagementRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The engagement's owner."},"content":{"type":["string","null"],"description":"The engagement's content."},"subject":{"type":["string","null"],"description":"The engagement's subject."},"direction":{"oneOf":[{"$ref":"#/components/schemas/DirectionEnum"},{"type":"null"}],"description":"The engagement's direction."},"engagement_type":{"type":["string","null"],"format":"uuid","description":"The engagement type of the engagement."},"start_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement started."},"end_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement ended."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the engagement."},"contacts":{"type":"array","items":{"type":"string","format":"uuid"}},"engagement_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The engagement's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Engagement Object\n### Description\nThe `Engagement` object is used to represent an interaction noted in a CRM system.\n### Usage Example\nTODO","title":"EngagementRequest"},"EngagementEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/EngagementRequest"}},"required":["model"],"title":"EngagementEndpointRequest"},"EngagementResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Engagement"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"EngagementResponse"},"EngagementsIdGetParametersExpandSchemaItems":{"type":"string","enum":["account","contacts","engagement_type","owner"],"title":"EngagementsIdGetParametersExpandSchemaItems"},"PatchedEngagementRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The engagement's owner."},"content":{"type":["string","null"],"description":"The engagement's content."},"subject":{"type":["string","null"],"description":"The engagement's subject."},"direction":{"oneOf":[{"$ref":"#/components/schemas/DirectionEnum"},{"type":"null"}],"description":"The engagement's direction."},"engagement_type":{"type":["string","null"],"format":"uuid","description":"The engagement type of the engagement."},"start_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement started."},"end_time":{"type":["string","null"],"format":"date-time","description":"The time at which the engagement ended."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the engagement."},"contacts":{"type":"array","items":{"type":"string","format":"uuid"}},"engagement_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The engagement's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Engagement Object\n### Description\nThe `Engagement` object is used to represent an interaction noted in a CRM system.\n### Usage Example\nTODO","title":"PatchedEngagementRequest"},"PatchedEngagementEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/PatchedEngagementRequest"}},"required":["model"],"title":"PatchedEngagementEndpointRequest"},"LeadsGetParametersExpandSchemaItems":{"type":"string","enum":["converted_account","converted_contact","owner"],"title":"LeadsGetParametersExpandSchemaItems"},"LeadStatusEnum":{"type":"string","enum":["OPEN","CLOSED","UNQUALIFIED","QUALIFIED"],"title":"LeadStatusEnum"},"LeadFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"LeadFieldMappings"},"Lead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"owner":{"type":["string","null"],"format":"uuid","description":"The lead's owner."},"lead_source":{"type":["string","null"],"description":"The lead's source."},"title":{"type":["string","null"],"description":"The lead's title."},"company":{"type":["string","null"],"description":"The lead's company."},"first_name":{"type":["string","null"],"description":"The lead's first name."},"last_name":{"type":["string","null"],"description":"The lead's last name."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"remote_updated_at":{"type":["string","null"],"format":"date-time","description":"When the third party's lead was updated."},"remote_created_at":{"type":["string","null"],"format":"date-time","description":"When the third party's lead was created."},"converted_date":{"type":["string","null"],"format":"date-time","description":"When the lead was converted."},"converted_contact":{"type":["string","null"],"format":"uuid","description":"The contact of the converted lead."},"converted_account":{"type":["string","null"],"format":"uuid","description":"The account of the converted lead."},"status":{"oneOf":[{"$ref":"#/components/schemas/LeadStatusEnum"},{"type":"null"}],"description":"The lead's status."},"lead_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The lead's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/LeadFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Lead Object\n### Description\nThe `Lead` object is used to represent an individual who is a potential customer.\n### Usage Example\nTODO","title":"Lead"},"PaginatedLeadList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Lead"}}},"title":"PaginatedLeadList"},"LeadRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The lead's owner."},"lead_source":{"type":["string","null"],"description":"The lead's source."},"title":{"type":["string","null"],"description":"The lead's title."},"company":{"type":["string","null"],"description":"The lead's company."},"first_name":{"type":["string","null"],"description":"The lead's first name."},"last_name":{"type":["string","null"],"description":"The lead's last name."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequest"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressRequest"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberRequest"}},"converted_date":{"type":["string","null"],"format":"date-time","description":"When the lead was converted."},"converted_contact":{"type":["string","null"],"format":"uuid","description":"The contact of the converted lead."},"converted_account":{"type":["string","null"],"format":"uuid","description":"The account of the converted lead."},"lead_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The lead's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Lead Object\n### Description\nThe `Lead` object is used to represent an individual who is a potential customer.\n### Usage Example\nTODO","title":"LeadRequest"},"LeadEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/LeadRequest"}},"required":["model"],"title":"LeadEndpointRequest"},"LeadResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Lead"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"LeadResponse"},"LeadsIdGetParametersExpandSchemaItems":{"type":"string","enum":["converted_account","converted_contact","owner"],"title":"LeadsIdGetParametersExpandSchemaItems"},"NotesGetParametersExpandSchemaItems":{"type":"string","enum":["account","contact","opportunity","owner"],"title":"NotesGetParametersExpandSchemaItems"},"NoteFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"NoteFieldMappings"},"Note":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"owner":{"type":["string","null"],"format":"uuid","description":"The note's owner."},"content":{"type":["string","null"],"description":"The note's content."},"contact":{"type":["string","null"],"format":"uuid","description":"The note's contact."},"account":{"type":["string","null"],"format":"uuid","description":"The note's account."},"opportunity":{"type":["string","null"],"format":"uuid","description":"The note's opportunity."},"note_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The note's URL in the remote system."},"remote_updated_at":{"type":["string","null"],"format":"date-time","description":"When the third party's lead was updated."},"remote_created_at":{"type":["string","null"],"format":"date-time","description":"When the third party's lead was created."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/NoteFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Note Object\n### Description\nThe `Note` object is used to represent a note on another object.\n### Usage Example\nTODO","title":"Note"},"PaginatedNoteList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}},"title":"PaginatedNoteList"},"NoteRequest":{"type":"object","properties":{"owner":{"type":["string","null"],"format":"uuid","description":"The note's owner."},"content":{"type":["string","null"],"description":"The note's content."},"contact":{"type":["string","null"],"format":"uuid","description":"The note's contact."},"account":{"type":["string","null"],"format":"uuid","description":"The note's account."},"opportunity":{"type":["string","null"],"format":"uuid","description":"The note's opportunity."},"note_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The note's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Note Object\n### Description\nThe `Note` object is used to represent a note on another object.\n### Usage Example\nTODO","title":"NoteRequest"},"NoteEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/NoteRequest"}},"required":["model"],"title":"NoteEndpointRequest"},"NoteResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Note"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"NoteResponse"},"NotesIdGetParametersExpandSchemaItems":{"type":"string","enum":["account","contact","opportunity","owner"],"title":"NotesIdGetParametersExpandSchemaItems"},"OpportunitiesGetParametersExpandSchemaItems":{"type":"string","enum":["account","owner","stage"],"title":"OpportunitiesGetParametersExpandSchemaItems"},"OpportunitiesGetParametersRemoteFields":{"type":"string","enum":["status"],"title":"OpportunitiesGetParametersRemoteFields"},"OpportunitiesGetParametersShowEnumOrigins":{"type":"string","enum":["status"],"title":"OpportunitiesGetParametersShowEnumOrigins"},"OpportunitiesGetParametersStatus":{"type":"string","enum":["LOST","OPEN","WON"],"title":"OpportunitiesGetParametersStatus"},"OpportunityStatusEnum":{"type":"string","enum":["OPEN","WON","LOST"],"title":"OpportunityStatusEnum"},"OpportunityFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"OpportunityFieldMappings"},"Opportunity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"name":{"type":["string","null"],"description":"The opportunity's name."},"description":{"type":["string","null"],"description":"The opportunity's description."},"amount":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The opportunity's amount."},"owner":{"type":["string","null"],"format":"uuid","description":"The opportunity's owner."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the opportunity."},"stage":{"type":["string","null"],"format":"uuid","description":"The stage of the opportunity."},"status":{"oneOf":[{"$ref":"#/components/schemas/OpportunityStatusEnum"},{"type":"null"}],"description":"The opportunity's status."},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the opportunity's last activity occurred."},"close_date":{"type":["string","null"],"format":"date-time","description":"When the opportunity was closed."},"remote_created_at":{"type":["string","null"],"format":"date-time","description":"When the third party's opportunity was created."},"opportunity_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The opportunity's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/OpportunityFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Opportunity Object\n### Description\nThe `Opportunity` object is used to represent a deal opportunity in a CRM system.\n### Usage Example\nTODO","title":"Opportunity"},"PaginatedOpportunityList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}}},"title":"PaginatedOpportunityList"},"OpportunityRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The opportunity's name."},"description":{"type":["string","null"],"description":"The opportunity's description."},"amount":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The opportunity's amount."},"owner":{"type":["string","null"],"format":"uuid","description":"The opportunity's owner."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the opportunity."},"stage":{"type":["string","null"],"format":"uuid","description":"The stage of the opportunity."},"status":{"oneOf":[{"$ref":"#/components/schemas/OpportunityStatusEnum"},{"type":"null"}],"description":"The opportunity's status."},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the opportunity's last activity occurred."},"close_date":{"type":["string","null"],"format":"date-time","description":"When the opportunity was closed."},"opportunity_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The opportunity's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Opportunity Object\n### Description\nThe `Opportunity` object is used to represent a deal opportunity in a CRM system.\n### Usage Example\nTODO","title":"OpportunityRequest"},"OpportunityEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/OpportunityRequest"}},"required":["model"],"title":"OpportunityEndpointRequest"},"OpportunityResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Opportunity"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"OpportunityResponse"},"OpportunitiesIdGetParametersExpandSchemaItems":{"type":"string","enum":["account","owner","stage"],"title":"OpportunitiesIdGetParametersExpandSchemaItems"},"OpportunitiesIdGetParametersRemoteFields":{"type":"string","enum":["status"],"title":"OpportunitiesIdGetParametersRemoteFields"},"OpportunitiesIdGetParametersShowEnumOrigins":{"type":"string","enum":["status"],"title":"OpportunitiesIdGetParametersShowEnumOrigins"},"PatchedOpportunityRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The opportunity's name."},"description":{"type":["string","null"],"description":"The opportunity's description."},"amount":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647,"description":"The opportunity's amount."},"owner":{"type":["string","null"],"format":"uuid","description":"The opportunity's owner."},"account":{"type":["string","null"],"format":"uuid","description":"The account of the opportunity."},"stage":{"type":["string","null"],"format":"uuid","description":"The stage of the opportunity."},"status":{"oneOf":[{"$ref":"#/components/schemas/OpportunityStatusEnum"},{"type":"null"}],"description":"The opportunity's status."},"last_activity_at":{"type":["string","null"],"format":"date-time","description":"When the opportunity's last activity occurred."},"close_date":{"type":["string","null"],"format":"date-time","description":"When the opportunity was closed."},"opportunity_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The opportunity's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Opportunity Object\n### Description\nThe `Opportunity` object is used to represent a deal opportunity in a CRM system.\n### Usage Example\nTODO","title":"PatchedOpportunityRequest"},"PatchedOpportunityEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/PatchedOpportunityRequest"}},"required":["model"],"title":"PatchedOpportunityEndpointRequest"},"StageFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"StageFieldMappings"},"Stage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"name":{"type":["string","null"],"description":"The stage's name."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/StageFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Stage Object\n### Description\nThe `Stage` object is used to represent the stage of an opportunity.\n### Usage Example\nTODO","title":"Stage"},"PaginatedStageList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}},"title":"PaginatedStageList"},"TasksGetParametersExpandSchemaItems":{"type":"string","enum":["account","contact","opportunity","owner"],"title":"TasksGetParametersExpandSchemaItems"},"TaskStatusEnum":{"type":"string","enum":["OPEN","CLOSED"],"title":"TaskStatusEnum"},"TaskFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"TaskFieldMappings"},"Task":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"subject":{"type":["string","null"],"description":"The task's subject."},"content":{"type":["string","null"],"description":"The task's content."},"owner":{"type":["string","null"],"format":"uuid","description":"The task's owner."},"account":{"type":["string","null"],"format":"uuid","description":"The task's account."},"opportunity":{"type":["string","null"],"format":"uuid","description":"The task's opportunity."},"contact":{"type":["string","null"],"format":"uuid","description":"The task's contact."},"completed_date":{"type":["string","null"],"format":"date-time","description":"When the task is completed."},"due_date":{"type":["string","null"],"format":"date-time","description":"When the task is due."},"status":{"oneOf":[{"$ref":"#/components/schemas/TaskStatusEnum"},{"type":"null"}],"description":"The task's status."},"task_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The task's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/TaskFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The Task Object\n### Description\nThe `Task` object is used to represent a task, such as a to-do item.\n### Usage Example\nTODO","title":"Task"},"PaginatedTaskList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}},"title":"PaginatedTaskList"},"TaskRequest":{"type":"object","properties":{"subject":{"type":["string","null"],"description":"The task's subject."},"content":{"type":["string","null"],"description":"The task's content."},"owner":{"type":["string","null"],"format":"uuid","description":"The task's owner."},"account":{"type":["string","null"],"format":"uuid","description":"The task's account."},"opportunity":{"type":["string","null"],"format":"uuid","description":"The task's opportunity."},"contact":{"type":["string","null"],"format":"uuid","description":"The task's contact."},"completed_date":{"type":["string","null"],"format":"date-time","description":"When the task is completed."},"due_date":{"type":["string","null"],"format":"date-time","description":"When the task is due."},"status":{"oneOf":[{"$ref":"#/components/schemas/TaskStatusEnum"},{"type":"null"}],"description":"The task's status."},"task_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The task's URL in the remote system."},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldRequest"}}},"description":"# The Task Object\n### Description\nThe `Task` object is used to represent a task, such as a to-do item.\n### Usage Example\nTODO","title":"TaskRequest"},"TaskEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/TaskRequest"}},"required":["model"],"title":"TaskEndpointRequest"},"TaskResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Task"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"TaskResponse"},"TasksIdGetParametersExpandSchemaItems":{"type":"string","enum":["account","contact","opportunity","owner"],"title":"TasksIdGetParametersExpandSchemaItems"},"UserFieldMappings":{"type":"object","properties":{"organization_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}},"linked_account_defined_targets":{"type":"object","additionalProperties":{"description":"Any type"}}},"title":"UserFieldMappings"},"User":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"name":{"type":["string","null"],"description":"The user's name."},"email":{"type":["string","null"],"description":"The user's email address."},"is_active":{"type":["boolean","null"],"description":"Whether or not the user is active."},"user_url":{"type":["string","null"],"format":"uri","maxLength":2000,"description":"The user's URL in the remote system."},"remote_was_deleted":{"type":"boolean","description":"Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."},"field_mappings":{"oneOf":[{"$ref":"#/components/schemas/UserFieldMappings"},{"type":"null"}]},"remote_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RemoteData"}},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The User Object\n### Description\nThe `User` object is used to represent a user with a login to the CRM system.\n### Usage Example\nTODO","title":"User"},"PaginatedUserList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"title":"PaginatedUserList"},"users_ignoreCreate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"users_ignoreCreate_Response_200"},"CustomObjectClassesGetParametersExpandSchemaItems":{"type":"string","enum":["fields"],"title":"CustomObjectClassesGetParametersExpandSchemaItems"},"RemoteFieldClassForCustomObjectClassItemSchema":{"type":"object","properties":{"item_type":{"type":["string","null"]},"item_format":{"type":["string","null"]},"item_choices":{"type":["array","null"],"items":{"type":"string"}}},"required":["item_type","item_format","item_choices"],"title":"RemoteFieldClassForCustomObjectClassItemSchema"},"RemoteFieldClassForCustomObjectClass":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"display_name":{"type":["string","null"]},"remote_key_name":{"type":["string","null"]},"description":{"type":["string","null"]},"is_required":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"field_format":{"$ref":"#/components/schemas/FieldFormatEnum"},"field_choices":{"type":["array","null"],"items":{"type":"string"}},"item_schema":{"oneOf":[{"$ref":"#/components/schemas/RemoteFieldClassForCustomObjectClassItemSchema"},{"type":"null"}]}},"title":"RemoteFieldClassForCustomObjectClass"},"CustomObjectClass":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time"},"modified_at":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The custom object class's name."},"description":{"type":["string","null"],"description":"The custom object class's description."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The custom object class's singular and plural labels."},"fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldClassForCustomObjectClass"}},"association_types":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"The types of associations with other models that the custom object class can have."}},"description":"# The Custom Object Class Object\n### Description\nThe `Custom Object Class` object is used to represent a Custom Object Schema in the remote system.\n### Usage Example\nTODO","title":"CustomObjectClass"},"PaginatedCustomObjectClassList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectClass"}}},"title":"PaginatedCustomObjectClassList"},"CustomObjectClassesIdGetParametersExpandSchemaItems":{"type":"string","enum":["fields"],"title":"CustomObjectClassesIdGetParametersExpandSchemaItems"},"CustomObject":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"object_class":{"type":["string","null"],"format":"uuid","description":"The custom object class the custom object record belongs to."},"fields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The fields and values contained within the custom object record."},"remote_fields":{"type":"array","items":{"$ref":"#/components/schemas/RemoteField"}}},"description":"# The CustomObject Object\n### Description\nThe `Custom Object` record refers to an instance of a Custom Object Class.\n### Usage Example\nTODO","title":"CustomObject"},"PaginatedCustomObjectList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomObject"}}},"title":"PaginatedCustomObjectList"},"CustomObjectRequest":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"description":"Any type"}},"integration_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"linked_account_params":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["fields"],"title":"CustomObjectRequest"},"CRMCustomObjectEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/CustomObjectRequest"}},"required":["model"],"title":"CRMCustomObjectEndpointRequest"},"CRMCustomObjectResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/CustomObject"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"CRMCustomObjectResponse"},"CustomObjectClassesCustomObjectClassIdAssociationTypesGetParametersExpandSchemaItems":{"type":"string","enum":["target_object_classes"],"title":"CustomObjectClassesCustomObjectClassIdAssociationTypesGetParametersExpandSchemaItems"},"AssociationSubType":{"type":"object","properties":{"id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"origin_type":{"type":["string","null"]}},"title":"AssociationSubType"},"CardinalityEnum":{"type":"string","enum":["ONE_TO_ONE","MANY_TO_ONE","MANY_TO_MANY","ONE_TO_MANY"],"title":"CardinalityEnum"},"AssociationType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"remote_id":{"type":["string","null"],"description":"The third-party API ID of the matching object."},"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"source_object_class":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The class of the source object (Custom Object or Common Model) for the association type."},"target_object_classes":{"type":"array","items":{"$ref":"#/components/schemas/AssociationSubType"}},"remote_key_name":{"type":["string","null"]},"display_name":{"type":["string","null"]},"cardinality":{"oneOf":[{"$ref":"#/components/schemas/CardinalityEnum"},{"type":"null"}]},"is_required":{"type":"boolean"}},"description":"# The AssociationType Object\n### Description\nThe `Association Type` object represents the relationship between two objects.\n### Usage Example\nTODO","title":"AssociationType"},"PaginatedAssociationTypeList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/AssociationType"}}},"title":"PaginatedAssociationTypeList"},"OriginTypeEnum":{"type":"string","enum":["CUSTOM_OBJECT","COMMON_MODEL","REMOTE_ONLY_MODEL"],"title":"OriginTypeEnum"},"ObjectClassDescriptionRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1},"origin_type":{"$ref":"#/components/schemas/OriginTypeEnum"}},"required":["id","origin_type"],"title":"ObjectClassDescriptionRequest"},"AssociationTypeRequestRequest":{"type":"object","properties":{"source_object_class":{"$ref":"#/components/schemas/ObjectClassDescriptionRequest"},"target_object_classes":{"type":"array","items":{"$ref":"#/components/schemas/ObjectClassDescriptionRequest"}},"remote_key_name":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"cardinality":{"$ref":"#/components/schemas/CardinalityEnum"},"is_required":{"type":"boolean","default":false}},"required":["source_object_class","target_object_classes","remote_key_name"],"title":"AssociationTypeRequestRequest"},"CRMAssociationTypeEndpointRequest":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/AssociationTypeRequestRequest"}},"required":["model"],"title":"CRMAssociationTypeEndpointRequest"},"CRMAssociationTypeResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/AssociationType"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"CRMAssociationTypeResponse"},"CustomObjectClassesCustomObjectClassIdAssociationTypesIdGetParametersExpandSchemaItems":{"type":"string","enum":["target_object_classes"],"title":"CustomObjectClassesCustomObjectClassIdAssociationTypesIdGetParametersExpandSchemaItems"},"CustomObjectClassesCustomObjectClassIdCustomObjectsObjectIdAssociationsGetParametersExpandSchemaItems":{"type":"string","enum":["association_type"],"title":"CustomObjectClassesCustomObjectClassIdCustomObjectsObjectIdAssociationsGetParametersExpandSchemaItems"},"Association":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The datetime that this object was created by Merge."},"modified_at":{"type":"string","format":"date-time","description":"The datetime that this object was modified by Merge."},"source_object":{"type":"string","format":"uuid"},"target_object":{"type":"string","format":"uuid"},"association_type":{"type":["string","null"],"format":"uuid","description":"The association type the association belongs to."}},"description":"# The Association Object\n### Description\nThe `Association` record refers to an instance of an Association Type.\n### Usage Example\nTODO","title":"Association"},"PaginatedAssociationList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Association"}}},"title":"PaginatedAssociationList"},"CategoryEnum":{"type":"string","enum":["hris","ats","accounting","ticketing","crm","mktg","filestorage","knowledgebase"],"title":"CategoryEnum"},"AccountDetails":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"integration":{"type":"string"},"integration_slug":{"type":"string"},"category":{"oneOf":[{"$ref":"#/components/schemas/CategoryEnum"},{"type":"null"}]},"end_user_origin_id":{"type":"string"},"end_user_organization_name":{"type":"string"},"end_user_email_address":{"type":"string","format":"email"},"status":{"type":"string"},"webhook_listener_url":{"type":"string","format":"uri"},"is_duplicate":{"type":["boolean","null"],"description":"Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets."},"account_type":{"type":"string"},"completed_at":{"type":["string","null"],"format":"date-time","description":"The time at which account completes the linking flow."},"instance_id":{"type":["string","null"]},"instance_display_value":{"type":["string","null"]}},"title":"AccountDetails"},"CategoriesEnum":{"type":"string","enum":["hris","ats","accounting","ticketing","crm","mktg","filestorage","knowledgebase"],"title":"CategoriesEnum"},"AccountIntegrationCategoryBetaStatus":{"type":"object","properties":{},"description":"Category or categories this integration is in beta status for.","title":"AccountIntegrationCategoryBetaStatus"},"AccountIntegration":{"type":"object","properties":{"name":{"type":"string","description":"Company name."},"abbreviated_name":{"type":["string","null"],"description":"Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).
Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoriesEnum"},"description":"Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]."},"image":{"type":["string","null"],"format":"uri","description":"Company logo in rectangular shape."},"square_image":{"type":["string","null"],"format":"uri","description":"Company logo in square shape."},"color":{"type":"string","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$","maxLength":18,"description":"The color of this integration used for buttons and text throughout the app and landing pages. Choose a darker, saturated color."},"slug":{"type":"string"},"api_endpoints_to_documentation_urls":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}"},"webhook_setup_guide_url":{"type":["string","null"],"description":"Setup guide URL for third party webhook creation. Exposed in Merge Docs."},"category_beta_status":{"$ref":"#/components/schemas/AccountIntegrationCategoryBetaStatus","description":"Category or categories this integration is in beta status for."}},"required":["name"],"title":"AccountIntegration"},"AccountToken":{"type":"object","properties":{"account_token":{"type":"string"},"integration":{"$ref":"#/components/schemas/AccountIntegration"},"id":{"type":"string"}},"required":["account_token","integration","id"],"title":"AccountToken"},"RegenerateAccountToken":{"type":"object","properties":{"linked_account_id":{"type":"string"},"account_token":{"type":"string"}},"required":["linked_account_id","account_token"],"description":"# The RegenerateAccountToken Object\n### Description\nThe `RegenerateAccountToken` object is used to exchange an old account token for a new one.\n\n### Usage Example\nPost to receive a new `RegenerateAccountToken`.","title":"RegenerateAccountToken"},"deleteAccount_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"deleteAccount_delete_Response_200"},"IssuesGetParametersStatus":{"type":"string","enum":["ONGOING","RESOLVED"],"title":"IssuesGetParametersStatus"},"IssueStatusEnum":{"type":"string","enum":["ONGOING","RESOLVED"],"title":"IssueStatusEnum"},"Issue":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/IssueStatusEnum","description":"Status of the issue."},"error_description":{"type":"string"},"end_user":{"type":"object","additionalProperties":{"description":"Any type"}},"first_incident_time":{"type":["string","null"],"format":"date-time"},"last_incident_time":{"type":["string","null"],"format":"date-time"},"is_muted":{"type":"boolean"},"error_details":{"type":"array","items":{"type":"string"}}},"required":["error_description"],"title":"Issue"},"PaginatedIssueList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Issue"}}},"title":"PaginatedIssueList"},"LinkedAccountsGetParametersCategory":{"type":"string","enum":["accounting","ats","chat","crm","filestorage","hris","knowledgebase","mktg","ticketing"],"title":"LinkedAccountsGetParametersCategory"},"AccountDetailsAndActionsStatusEnum":{"type":"string","enum":["COMPLETE","INCOMPLETE","RELINK_NEEDED","IDLE"],"title":"AccountDetailsAndActionsStatusEnum"},"ModelOperation":{"type":"object","properties":{"model_name":{"type":"string"},"available_operations":{"type":"array","items":{"type":"string"}},"required_post_parameters":{"type":"array","items":{"type":"string"}},"supported_fields":{"type":"array","items":{"type":"string"}}},"required":["model_name","available_operations","required_post_parameters","supported_fields"],"description":"# The ModelOperation Object\n### Description\nThe `ModelOperation` object is used to represent the operations that are currently supported for a given model.\n\n### Usage Example\nView what operations are supported for the `Candidate` endpoint.","title":"ModelOperation"},"AccountDetailsAndActionsIntegration":{"type":"object","properties":{"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoriesEnum"}},"image":{"type":"string"},"square_image":{"type":"string"},"color":{"type":"string"},"slug":{"type":"string"},"passthrough_available":{"type":"boolean"},"available_model_operations":{"type":"array","items":{"$ref":"#/components/schemas/ModelOperation"}}},"required":["name","categories","color","slug","passthrough_available"],"title":"AccountDetailsAndActionsIntegration"},"AccountDetailsAndActions":{"type":"object","properties":{"id":{"type":"string"},"category":{"$ref":"#/components/schemas/CategoryEnum"},"status":{"$ref":"#/components/schemas/AccountDetailsAndActionsStatusEnum"},"status_detail":{"type":"string"},"end_user_origin_id":{"type":"string"},"end_user_organization_name":{"type":"string"},"end_user_email_address":{"type":"string"},"subdomain":{"type":"string","description":"The tenant or domain the customer has provided access to."},"webhook_listener_url":{"type":"string"},"is_duplicate":{"type":["boolean","null"],"description":"Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets."},"integration":{"$ref":"#/components/schemas/AccountDetailsAndActionsIntegration"},"account_type":{"type":"string"},"completed_at":{"type":"string","format":"date-time"},"integration_specific_fields":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["id","status","end_user_organization_name","end_user_email_address","webhook_listener_url","account_type","completed_at"],"description":"# The LinkedAccount Object\n### Description\nThe `LinkedAccount` object is used to represent an end user's link with a specific integration.\n\n### Usage Example\nView a list of your organization's `LinkedAccount` objects.","title":"AccountDetailsAndActions"},"PaginatedAccountDetailsAndActionsList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountDetailsAndActions"}}},"title":"PaginatedAccountDetailsAndActionsList"},"EnabledActionsEnum":{"type":"string","enum":["READ","WRITE"],"title":"EnabledActionsEnum"},"CommonModelScopesBodyRequest":{"type":"object","properties":{"model_id":{"type":"string","minLength":1},"enabled_actions":{"type":"array","items":{"$ref":"#/components/schemas/EnabledActionsEnum"}},"disabled_fields":{"type":"array","items":{"type":"string","minLength":1}}},"required":["model_id","enabled_actions","disabled_fields"],"title":"CommonModelScopesBodyRequest"},"ModelPermissionDeserializerRequest":{"type":"object","properties":{"is_enabled":{"type":"boolean"}},"title":"ModelPermissionDeserializerRequest"},"FieldPermissionDeserializerRequest":{"type":"object","properties":{"enabled_fields":{"type":"array","items":{"description":"Any type"}},"disabled_fields":{"type":"array","items":{"description":"Any type"}}},"title":"FieldPermissionDeserializerRequest"},"IndividualCommonModelScopeDeserializerRequest":{"type":"object","properties":{"model_name":{"type":"string","minLength":1},"model_permissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ModelPermissionDeserializerRequest"}},"field_permissions":{"$ref":"#/components/schemas/FieldPermissionDeserializerRequest"}},"required":["model_name"],"title":"IndividualCommonModelScopeDeserializerRequest"},"LanguageEnum":{"type":"string","enum":["en","de"],"title":"LanguageEnum"},"CompletedAccountInitialScreenEnum":{"type":"string","enum":["SELECTIVE_SYNC"],"title":"CompletedAccountInitialScreenEnum"},"EndUserDetailsRequest":{"type":"object","properties":{"end_user_email_address":{"type":"string","minLength":1,"maxLength":100,"description":"Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent."},"end_user_organization_name":{"type":"string","minLength":1,"maxLength":100,"description":"Your end user's organization."},"end_user_origin_id":{"type":"string","minLength":1,"maxLength":100,"description":"This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers."},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoriesEnum"},"description":"The integration categories to show in Merge Link."},"integration":{"type":["string","null"],"minLength":1,"description":"The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/."},"link_expiry_mins":{"type":"integer","minimum":30,"maximum":10080,"default":30,"description":"An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30."},"should_create_magic_link_url":{"type":["boolean","null"],"default":false,"description":"Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link."},"hide_admin_magic_link":{"type":["boolean","null"],"default":false,"description":"Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link."},"common_models":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CommonModelScopesBodyRequest"},"description":"An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account."},"category_common_model_scopes":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/IndividualCommonModelScopeDeserializerRequest"}},"description":"When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings."},"language":{"oneOf":[{"$ref":"#/components/schemas/LanguageEnum"},{"type":"null"}],"description":"The following subset of IETF language tags can be used to configure localization."},"are_syncs_disabled":{"type":["boolean","null"],"default":false,"description":"The boolean that indicates whether initial, periodic, and force syncs will be disabled."},"integration_specific_config":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A JSON object containing integration-specific configuration options."},"completed_account_initial_screen":{"oneOf":[{"$ref":"#/components/schemas/CompletedAccountInitialScreenEnum"},{"type":"null"}],"description":"When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account."},"linked_destination_id":{"type":["string","null"],"format":"uuid","description":"The UUID of the linked destination that you want this Linked Account to be tied to."},"credential_id":{"type":["string","null"],"format":"uuid","description":"The id of the credential that you want this Linked Account to be tied to."},"ekm_enabled":{"type":"boolean","default":false,"description":"Whether to enable EKM (External Key Management) for this Linked Account."}},"required":["end_user_email_address","end_user_organization_name","end_user_origin_id","categories"],"title":"EndUserDetailsRequest"},"LinkToken":{"type":"object","properties":{"link_token":{"type":"string"},"integration_name":{"type":"string"},"magic_link_url":{"type":"string"}},"required":["link_token"],"title":"LinkToken"},"FieldMappingApiInstanceTargetField":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"is_organization_wide":{"type":"boolean"}},"required":["name","description","is_organization_wide"],"title":"FieldMappingApiInstanceTargetField"},"FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo":{"type":"object","properties":{"method":{"type":["string","null"]},"url_path":{"type":["string","null"]},"field_traversal_path":{"type":["array","null"],"items":{"type":"string"}}},"required":["method","url_path","field_traversal_path"],"title":"FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo"},"FieldMappingApiInstanceRemoteField":{"type":"object","properties":{"remote_key_name":{"type":["string","null"]},"schema":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"remote_endpoint_info":{"$ref":"#/components/schemas/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo"}},"required":["remote_key_name","schema","remote_endpoint_info"],"title":"FieldMappingApiInstanceRemoteField"},"FieldMappingApiInstance":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"is_integration_wide":{"type":"boolean"},"target_field":{"oneOf":[{"$ref":"#/components/schemas/FieldMappingApiInstanceTargetField"},{"type":"null"}]},"remote_field":{"oneOf":[{"$ref":"#/components/schemas/FieldMappingApiInstanceRemoteField"},{"type":"null"}]},"jmes_path":{"type":["string","null"]},"advanced_mapping_expression":{"type":["string","null"]}},"title":"FieldMappingApiInstance"},"FieldMappingApiInstanceResponse":{"type":"object","properties":{"Account":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Contact":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Lead":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Note":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Opportunity":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Stage":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"User":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Task":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}},"Engagement":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingApiInstance"}}},"title":"FieldMappingApiInstanceResponse"},"CreateFieldMappingRequest":{"type":"object","properties":{"target_field_name":{"type":"string","minLength":1,"description":"The name of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided."},"target_field_description":{"type":"string","minLength":1,"description":"The description of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided."},"organization_wide_target_field":{"type":"string","minLength":1,"description":"The name or key of an existing Organization-wide target field to map to. When provided, target_field_name and target_field_description are optional."},"is_integration_wide":{"type":"boolean","default":false,"description":"If true, creates an integration-wide field mapping that applies to all Linked Accounts for the integration. Requires organization_wide_target_field."},"remote_field_traversal_path":{"type":"array","items":{"description":"Any type"},"description":"The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint."},"remote_method":{"type":"string","minLength":1,"description":"The method of the remote endpoint where the remote field is coming from."},"remote_url_path":{"type":"string","minLength":1,"description":"The path of the remote endpoint where the remote field is coming from."},"common_model_name":{"type":"string","minLength":1,"description":"The name of the Common Model that the remote field corresponds to in a given category."},"jmes_path":{"type":"string","minLength":1,"description":"DEPRECATED: Use 'advanced_mapping_expression' instead."},"advanced_mapping_expression":{"type":"string","minLength":1,"description":"A JSONata expression used to transform the remote field data."}},"required":["remote_field_traversal_path","remote_method","remote_url_path","common_model_name"],"title":"CreateFieldMappingRequest"},"FieldMappingInstanceResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/FieldMappingApiInstance"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningValidationProblem"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorValidationProblem"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/DebugModeLog"}}},"required":["model","warnings","errors"],"title":"FieldMappingInstanceResponse"},"PatchedEditFieldMappingRequest":{"type":"object","properties":{"remote_field_traversal_path":{"type":"array","items":{"description":"Any type"},"description":"The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint."},"remote_method":{"type":"string","minLength":1,"description":"The method of the remote endpoint where the remote field is coming from."},"remote_url_path":{"type":"string","minLength":1,"description":"The path of the remote endpoint where the remote field is coming from."},"jmes_path":{"type":"string","minLength":1,"description":"DEPRECATED: Use 'advanced_mapping_expression' instead."},"advanced_mapping_expression":{"type":"string","minLength":1,"description":"A JSONata expression used to transform the remote field data."}},"title":"PatchedEditFieldMappingRequest"},"RemoteEndpointInfo":{"type":"object","properties":{"method":{"type":"string"},"url_path":{"type":"string"},"field_traversal_path":{"type":"array","items":{"description":"Any type"}}},"required":["method","url_path","field_traversal_path"],"title":"RemoteEndpointInfo"},"AdvancedMetadata":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"description":{"type":"string"},"is_required":{"type":"boolean"},"is_custom":{"type":"boolean"},"field_choices":{"type":"array","items":{"description":"Any type"}}},"required":["id"],"title":"AdvancedMetadata"},"RemoteFieldApiCoverage":{"oneOf":[{"type":"integer"},{"type":"number","format":"double"}],"title":"RemoteFieldApiCoverage"},"RemoteFieldAPI":{"type":"object","properties":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}},"remote_key_name":{"type":"string"},"remote_endpoint_info":{"$ref":"#/components/schemas/RemoteEndpointInfo"},"example_values":{"type":["array","null"],"items":{"description":"Any type"}},"advanced_metadata":{"oneOf":[{"$ref":"#/components/schemas/AdvancedMetadata"},{"type":"null"}]},"coverage":{"oneOf":[{"$ref":"#/components/schemas/RemoteFieldApiCoverage"},{"type":"null"}]}},"required":["schema","remote_key_name","remote_endpoint_info","advanced_metadata"],"title":"RemoteFieldAPI"},"RemoteFieldAPIResponse":{"type":"object","properties":{"Account":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Contact":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Lead":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Note":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Opportunity":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Stage":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"User":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Task":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}},"Engagement":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFieldAPI"}}},"title":"RemoteFieldAPIResponse"},"ExternalTargetFieldAPI":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]},"is_mapped":{"type":["string","null"]}},"title":"ExternalTargetFieldAPI"},"ExternalTargetFieldAPIResponse":{"type":"object","properties":{"Account":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Contact":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Lead":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Note":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Opportunity":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Stage":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"User":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Task":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}},"Engagement":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTargetFieldAPI"}}},"title":"ExternalTargetFieldAPIResponse"},"CreateTargetFieldRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the target field."},"description":{"type":"string","minLength":1,"default":"","description":"The description of the target field."},"common_model":{"type":"string","minLength":1,"description":"The name of the Common Model to associate the target field with."}},"required":["name","common_model"],"title":"CreateTargetFieldRequest"},"AvailableActions":{"type":"object","properties":{"integration":{"$ref":"#/components/schemas/AccountIntegration"},"passthrough_available":{"type":"boolean"},"available_model_operations":{"type":"array","items":{"$ref":"#/components/schemas/ModelOperation"}}},"required":["integration","passthrough_available"],"description":"# The AvailableActions Object\n### Description\nThe `Activity` object is used to see all available model/operation combinations for an integration.\n\n### Usage Example\nFetch all the actions available for the `Zenefits` integration.","title":"AvailableActions"},"ModelPermissionDeserializer":{"type":"object","properties":{"is_enabled":{"type":"boolean"}},"title":"ModelPermissionDeserializer"},"FieldPermissionDeserializer":{"type":"object","properties":{"enabled_fields":{"type":"array","items":{"description":"Any type"}},"disabled_fields":{"type":"array","items":{"description":"Any type"}}},"title":"FieldPermissionDeserializer"},"IndividualCommonModelScopeDeserializer":{"type":"object","properties":{"model_name":{"type":"string"},"model_permissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ModelPermissionDeserializer"}},"field_permissions":{"$ref":"#/components/schemas/FieldPermissionDeserializer"}},"required":["model_name"],"title":"IndividualCommonModelScopeDeserializer"},"CommonModelScopeAPI":{"type":"object","properties":{"common_models":{"type":"array","items":{"$ref":"#/components/schemas/IndividualCommonModelScopeDeserializer"},"description":"The common models you want to update the scopes for"}},"required":["common_models"],"title":"CommonModelScopeAPI"},"LinkedAccountCommonModelScopeDeserializerRequest":{"type":"object","properties":{"common_models":{"type":"array","items":{"$ref":"#/components/schemas/IndividualCommonModelScopeDeserializerRequest"},"description":"The common models you want to update the scopes for"}},"required":["common_models"],"title":"LinkedAccountCommonModelScopeDeserializerRequest"},"LastSyncResultEnum":{"type":"string","enum":["SYNCING","DONE","FAILED","DISABLED","PAUSED","PARTIALLY_SYNCED"],"title":"LastSyncResultEnum"},"StatusFd5Enum":{"type":"string","enum":["SYNCING","DONE","FAILED","DISABLED","PAUSED","PARTIALLY_SYNCED"],"title":"StatusFd5Enum"},"SyncStatusReasonEnum":{"type":"string","enum":["RATE_LIMITED","WAITING_ON_OTHER_MODELS"],"title":"SyncStatusReasonEnum"},"SelectiveSyncConfigurationsUsageEnum":{"type":"string","enum":["IN_NEXT_SYNC","IN_LAST_SYNC"],"title":"SelectiveSyncConfigurationsUsageEnum"},"SyncStatus":{"type":"object","properties":{"model_name":{"type":"string"},"model_id":{"type":"string"},"last_sync_start":{"type":"string","format":"date-time"},"next_sync_start":{"type":"string","format":"date-time"},"last_sync_result":{"$ref":"#/components/schemas/LastSyncResultEnum"},"last_sync_finished":{"type":"string","format":"date-time"},"data_fresh_as_of":{"type":["string","null"],"format":"date-time","description":"The point in time that this model's data is complete through. This is the start time of the most recent sync that completed successfully for the model. The data is current at least through this time and may be fresher. Null until the first sync completes."},"status":{"$ref":"#/components/schemas/StatusFd5Enum"},"sync_status_reason":{"oneOf":[{"$ref":"#/components/schemas/SyncStatusReasonEnum"},{"type":"null"}],"description":"Why a model is healthy but not actively progressing while its `status` stays `SYNCING`. Null when the model is progressing normally. `RATE_LIMITED` means the model is paused behind the data provider's rate limits. `WAITING_ON_OTHER_MODELS` means the model is on hold until other models finish syncing."},"is_initial_sync":{"type":"boolean"},"selective_sync_configurations_usage":{"$ref":"#/components/schemas/SelectiveSyncConfigurationsUsageEnum"}},"required":["model_name","model_id","status","sync_status_reason","is_initial_sync"],"description":"# The SyncStatus Object\n### Description\nThe `SyncStatus` object is used to represent the syncing state of an account\n\n### Usage Example\nView the `SyncStatus` for an account to see how recently its models were synced.","title":"SyncStatus"},"MethodEnum":{"type":"string","enum":["GET","OPTIONS","HEAD","POST","PUT","PATCH","DELETE"],"title":"MethodEnum"},"EncodingEnum":{"type":"string","enum":["RAW","BASE64","GZIP_BASE64"],"title":"EncodingEnum"},"MultipartFormFieldRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the form field"},"data":{"type":"string","minLength":1,"description":"The data for the form field."},"encoding":{"oneOf":[{"$ref":"#/components/schemas/EncodingEnum"},{"type":"null"}],"default":"RAW","description":"The encoding of the value of `data`. Defaults to `RAW` if not defined."},"file_name":{"type":["string","null"],"minLength":1,"description":"The file name of the form field, if the field is for a file."},"content_type":{"type":["string","null"],"minLength":1,"description":"The MIME type of the file, if the field is for a file."}},"required":["name","data"],"description":"# The MultipartFormField Object\n### Description\nThe `MultipartFormField` object is used to represent fields in an HTTP request using `multipart/form-data`.\n\n### Usage Example\nCreate a `MultipartFormField` to define a multipart form entry.","title":"MultipartFormFieldRequest"},"RequestFormatEnum":{"type":"string","enum":["JSON","XML","MULTIPART"],"title":"RequestFormatEnum"},"DataPassthroughRequest":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/MethodEnum"},"path":{"type":"string","minLength":1,"description":"The path of the request in the third party's platform."},"base_url_override":{"type":["string","null"],"minLength":1,"description":"An optional override of the third party's base url for the request."},"data":{"type":["string","null"],"minLength":1,"description":"The data with the request. You must include a `request_format` parameter matching the data's format"},"multipart_form_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/MultipartFormFieldRequest"},"description":"Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`."},"headers":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server."},"request_format":{"oneOf":[{"$ref":"#/components/schemas/RequestFormatEnum"},{"type":"null"}]},"normalize_response":{"type":"boolean","description":"Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`."}},"required":["method","path"],"description":"# The DataPassthrough Object\n### Description\nThe `DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint.\n\n### Usage Example\nCreate a `DataPassthrough` to get team hierarchies from your Rippling integration.","title":"DataPassthroughRequest"},"ResponseTypeEnum":{"type":"string","enum":["JSON","BASE64_GZIP"],"title":"ResponseTypeEnum"},"RemoteResponse":{"type":"object","properties":{"method":{"type":"string"},"path":{"type":"string"},"status":{"type":"integer"},"response":{"description":"Any type"},"response_headers":{"type":"object","additionalProperties":{"description":"Any type"}},"response_type":{"$ref":"#/components/schemas/ResponseTypeEnum"},"headers":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["method","path","status","response"],"description":"# The RemoteResponse Object\n### Description\nThe `RemoteResponse` object is used to represent information returned from a third-party endpoint.\n\n### Usage Example\nView the `RemoteResponse` returned from your `DataPassthrough`.","title":"RemoteResponse"},"AsyncPassthroughReciept":{"type":"object","properties":{"async_passthrough_receipt_id":{"type":"string","format":"uuid"}},"required":["async_passthrough_receipt_id"],"title":"AsyncPassthroughReciept"},"PaginatedSyncStatusList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/SyncStatus"}}},"title":"PaginatedSyncStatusList"},"GenerateRemoteKeyRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the remote key"}},"required":["name"],"description":"# The GenerateRemoteKey Object\n### Description\nThe `GenerateRemoteKey` object is used to represent a request for a new remote key.\n\n### Usage Example\nPost a `GenerateRemoteKey` to create a new remote key.","title":"GenerateRemoteKeyRequest"},"RemoteKey":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}},"required":["name","key"],"description":"# The RemoteKey Object\n### Description\nThe `RemoteKey` object is used to represent a request for a new remote key.\n\n### Usage Example\nPost a `GenerateRemoteKey` to receive a new `RemoteKey`.","title":"RemoteKey"},"RemoteKeyForRegenerationRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the remote key"}},"required":["name"],"description":"# The RemoteKeyForRegeneration Object\n### Description\nThe `RemoteKeyForRegeneration` object is used to exchange an old remote key for a new one\n\n### Usage Example\nPost a `RemoteKeyForRegeneration` to swap out an old remote key for a new one","title":"RemoteKeyForRegenerationRequest"},"RoleEnum":{"type":"string","enum":["ADMIN","DEVELOPER","MEMBER","API","SYSTEM","MERGE_TEAM","SUPPORT","END_USER"],"title":"RoleEnum"},"EventTypeEnum":{"type":"string","enum":["CREATED_REMOTE_PRODUCTION_API_KEY","DELETED_REMOTE_PRODUCTION_API_KEY","CREATED_TEST_API_KEY","DELETED_TEST_API_KEY","REGENERATED_PRODUCTION_API_KEY","REGENERATED_WEBHOOK_SIGNATURE","INVITED_USER","TWO_FACTOR_AUTH_ENABLED","TWO_FACTOR_AUTH_DISABLED","DELETED_LINKED_ACCOUNT","DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT","CREATED_DESTINATION","DELETED_DESTINATION","CHANGED_DESTINATION","CHANGED_SCOPES","CHANGED_PERSONAL_INFORMATION","CHANGED_ORGANIZATION_SETTINGS","ENABLED_INTEGRATION","DISABLED_INTEGRATION","ENABLED_CATEGORY","DISABLED_CATEGORY","CHANGED_PASSWORD","RESET_PASSWORD","ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION","ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT","DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION","DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT","CREATED_INTEGRATION_WIDE_FIELD_MAPPING","CREATED_LINKED_ACCOUNT_FIELD_MAPPING","CHANGED_INTEGRATION_WIDE_FIELD_MAPPING","CHANGED_LINKED_ACCOUNT_FIELD_MAPPING","DELETED_INTEGRATION_WIDE_FIELD_MAPPING","DELETED_LINKED_ACCOUNT_FIELD_MAPPING","CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE","CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE","DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE","FORCED_LINKED_ACCOUNT_RESYNC","MUTED_ISSUE","GENERATED_MAGIC_LINK","ENABLED_MERGE_WEBHOOK","DISABLED_MERGE_WEBHOOK","MERGE_WEBHOOK_TARGET_CHANGED","END_USER_CREDENTIALS_ACCESSED","CHANGED_SELECTIVE_SYNC_FILTERS","ADDED_PARTNER_CREDENTIALS","UPDATED_PARTNER_CREDENTIALS","REMOVED_PARTNER_CREDENTIALS"],"title":"EventTypeEnum"},"AuditLogEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"user_name":{"type":["string","null"],"maxLength":200,"description":"The User's full name at the time of this Event occurring."},"user_email":{"type":["string","null"],"format":"email","maxLength":254,"description":"The User's email at the time of this Event occurring."},"linked_account_id":{"type":["string","null"],"format":"uuid","description":"The id of the Linked Account this event was performed on, when the actor is an End User acting inside Merge Link."},"role":{"$ref":"#/components/schemas/RoleEnum","description":"Designates the role of the user (or SYSTEM/API if action not taken by a user) at the time of this Event occurring."},"ip_address":{"type":"string","maxLength":45},"event_type":{"$ref":"#/components/schemas/EventTypeEnum","description":"Designates the type of event that occurred."},"event_description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["role","ip_address","event_type","event_description"],"title":"AuditLogEvent"},"PaginatedAuditLogEventList":{"type":"object","properties":{"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEvent"}}},"title":"PaginatedAuditLogEventList"}},"securitySchemes":{"tokenAuth":{"type":"http","scheme":"bearer","description":"Token-based authentication with required prefix \"Bearer\""}}}}