openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 115 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"email":"integrations@salesloft.com","x-twitter":"SalesLoft"},"description":"SalesLoft helps transform sales teams into modern sales organizations - converting more target accounts into customer accounts\n","title":"SalesLoft Platform","version":"v2","x-apisguru-categories":["customer_relation"],"x-logo":{"url":"https://twitter.com/SalesLoft/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developers.salesloft.com/v2_api_def.json","version":"2.0"}],"x-providerName":"salesloft.com"},"tags":[{"description":"User Information","name":"Me"},{"description":"Team Information","name":"Team"},{"description":"Account Management","name":"Accounts"},{"description":"Actions","name":"Actions"},{"description":"Actions - Call Instructions","name":"Action Details - Call Instructions"},{"description":"CRM Activity Management","name":"CRM Activities"},{"description":"Cadence Management","name":"Cadences"},{"description":"Cadence Membership","name":"Cadence Memberships"},{"description":"Call Data Record Management","name":"Call Data Records"},{"description":"Call Management","name":"Calls"},{"description":"Caller ID Information","name":"Caller IDs"},{"description":"Custom Field Management","name":"Custom Fields"},{"description":"Email Management","name":"Emails"},{"description":"Email Templates Management","name":"Email Templates"},{"description":"Import Management","name":"Imports"},{"description":"Note Management","name":"Notes"},{"description":"Person Management","name":"People"},{"description":"Person Stage Management","name":"Person Stages"},{"description":"Recording Settings Information","name":"Recording Settings"},{"description":"Steps","name":"Steps"},{"description":"Success Management","name":"Successes"},{"description":"Team Template Management","name":"Team Templates"},{"description":"User Management","name":"Users"}],"paths":{"/v2/accounts.json":{"get":{"description":"Fetches multiple account records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of accounts to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Domain of the accounts to fetch. Domains are unique and lowercase","in":"query","name":"domain","required":false,"schema":{"type":"string"}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_contacted_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Account"},"type":"array"}}}}},"summary":"List accounts","tags":["Accounts"]},"post":{"description":"Creates an account.\n\n\"domain\" must be unique on the current team.\n","requestBody":{"$ref":"#/components/requestBodies/postV2AccountsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Create an account","tags":["Accounts"]}},"/v2/accounts/{id}.json":{"delete":{"description":"Deletes an account. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n\nDeleting an account will remove all connected people from that account.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Account has been deleted successfully"}},"summary":"Delete an account","tags":["Accounts"]},"get":{"description":"Fetches an account, by ID only.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Fetch an account","tags":["Accounts"]},"put":{"description":"Updates an account.\n\n\"domain\" must be unique on the current team.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postV2AccountsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Update an existing Account","tags":["Accounts"]}},"/v2/action_details/call_instructions.json":{"get":{"description":"Fetches multiple call instruction records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of call instructions to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallInstruction"},"type":"array"}}}}},"summary":"List call instructions","tags":["Action Details - Call Instructions"]}},"/v2/action_details/call_instructions/{id}.json":{"get":{"description":"Fetches a call instruction, by ID only.\n","parameters":[{"description":"Call instructions ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallInstruction"}}}}},"summary":"Fetch a call instructions","tags":["Action Details - Call Instructions"]}},"/v2/actions.json":{"get":{"description":"Fetches multiple action records. The records can be filtered, paged, and sorted according to\nthe respective parameters. Only actions that are currently \"in_progess\" will be returned by\nthis endpoint.\n","parameters":[{"description":"IDs of actions to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Fetch actions by step ID","in":"query","name":"step_id","required":false,"schema":{"type":"integer"}},{"description":"Filter actions by type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Equality filters that are applied to the due_on field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"due_on","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Action"},"type":"array"}}}}},"summary":"List actions","tags":["Actions"]}},"/v2/actions/{id}.json":{"get":{"description":"Fetches an action, by ID only.\nThis endpoint will only return actions that are in_progress or pending_activity.\nOnce an action is complete, the request for that action will return a 404 status code.\n","parameters":[{"description":"Action ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Action"}}}}},"summary":"Fetch an action","tags":["Actions"]}},"/v2/activities/calls.json":{"get":{"description":"Fetches multiple call records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of calls to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Call"},"type":"array"}}}}},"summary":"List calls","tags":["Calls"]}},"/v2/activities/calls/{id}.json":{"get":{"description":"Fetches a call, by ID only.\n","parameters":[{"description":"Call ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Call"}}}}},"summary":"Fetch a call","tags":["Calls"]}},"/v2/activities/emails.json":{"get":{"description":"Fetches multiple email records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters emails by whether they have bounced or not","in":"query","name":"bounced","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"}}}}},"summary":"List emails","tags":["Emails"]}},"/v2/activities/emails/{id}.json":{"get":{"description":"Fetches an email, by ID only.\n","parameters":[{"description":"Email ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Email"}}}}},"summary":"Fetch an email","tags":["Emails"]}},"/v2/cadence_memberships.json":{"get":{"description":"Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to\nthe respective parameters. A cadence membership is the association between a person and their current and\nhistorical time on a cadence. Cadence membership records are mutable and change over time. If a person is\nadded to a cadence and re-added to the same cadence in the future, there is a single membership record.\n","parameters":[{"description":"IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"ID of the person to find cadence memberships for","in":"query","name":"person_id","required":false,"schema":{"type":"integer"}},{"description":"ID of the cadence to find cadence memberships for","in":"query","name":"cadence_id","required":false,"schema":{"type":"integer"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CadenceMembership"},"type":"array"}}}}},"summary":"List cadence memberships","tags":["Cadence Memberships"]},"post":{"description":"Adds a person to a cadence. person_id and cadence_id are required, and must be visible to the authenticated user. user_id will\ndefault to the authenticated user, but can be set to any visible user on the authenticated team.\n\nA person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, or the cadence is owned by\nthe teammate.\n","parameters":[{"description":"ID of the person to create a cadence membership for","in":"query","name":"person_id","required":true,"schema":{"type":"integer"}},{"description":"ID of the cadence to create a cadence membership for","in":"query","name":"cadence_id","required":true,"schema":{"type":"integer"}},{"description":"ID of the user to create a cadence membership for. The associated cadence must be owned by the user, or it must be a team cadence","in":"query","name":"user_id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CadenceMembership"}}}}},"summary":"Create a cadence membership","tags":["Cadence Memberships"]}},"/v2/cadence_memberships/{id}.json":{"delete":{"parameters":[{"description":"CadenceMembership ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The person has been removed from the cadence successfully"}},"summary":"Delete a cadence membership","tags":["Cadence Memberships"]},"get":{"description":"Fetches a cadence membership, by ID only.\n","parameters":[{"description":"CadenceMembership ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CadenceMembership"}}}}},"summary":"Fetch a cadence membership","tags":["Cadence Memberships"]}},"/v2/cadences.json":{"get":{"description":"Fetches multiple cadence records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of cadences to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters cadences by whether they are a team cadence or not","in":"query","name":"team_cadence","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Cadence"},"type":"array"}}}}},"summary":"List cadences","tags":["Cadences"]}},"/v2/cadences/{id}.json":{"get":{"description":"Fetches a cadence, by ID only.\n","parameters":[{"description":"Cadence ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Cadence"}}}}},"summary":"Fetch a cadence","tags":["Cadences"]}},"/v2/call_data_records.json":{"get":{"description":"Fetches multiple call data records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n\nCall data records are records of all inbound and outbound calls through SalesLoft. A call data record may\nbe associated with a call, but does not have to be.\n","parameters":[{"description":"IDs of call data records to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Return only call data records which have or do not have a call logged for them","in":"query","name":"has_call","required":false,"schema":{"type":"boolean"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallDataRecord"},"type":"array"}}}}},"summary":"List call data records","tags":["Call Data Records"]}},"/v2/call_data_records/{id}.json":{"get":{"description":"Fetches a call data record, by ID only.\n","parameters":[{"description":"CallDataRecord ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallDataRecord"}}}}},"summary":"Fetch a call data record","tags":["Call Data Records"]}},"/v2/crm_activities.json":{"get":{"description":"Fetches multiple crm activity records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of crm activities to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CrmActivity"},"type":"array"}}}}},"summary":"List crm activities","tags":["CRM Activities"]}},"/v2/crm_activities/{id}.json":{"get":{"description":"Fetches a crm activity, by ID only.\n","parameters":[{"description":"Crm activity ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CrmActivity"}}}}},"summary":"Fetch a crm activity","tags":["CRM Activities"]}},"/v2/custom_fields.json":{"get":{"description":"Fetches multiple custom field records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of custom fields to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Type of field to fetch. Value must be one of: person, company, opportunity","in":"query","name":"field_type","required":false,"schema":{"type":"string"}},{"description":"Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"}}}}},"summary":"List custom fields","tags":["Custom Fields"]},"post":{"description":"Creates a custom field.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the custom field","type":"string"},"field_type":{"description":"The field type of the custom field. Value must be one of: person, company, opportunity","type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Create a custom field","tags":["Custom Fields"]}},"/v2/custom_fields/{id}.json":{"delete":{"description":"Deletes a custom field.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Custom Field has been deleted successfully"}},"summary":"Delete a custom field","tags":["Custom Fields"]},"get":{"description":"Fetches a custom field, by ID only.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Fetch a custom field","tags":["Custom Fields"]},"put":{"description":"Update a custom field.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the custom field","type":"string"},"field_type":{"description":"The field type of the custom field. Value must be one of: person, company, opportunity","type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Update a custom field","tags":["Custom Fields"]}},"/v2/email_templates.json":{"get":{"description":"Fetches multiple email template records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of email templates to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters email templates by whether they are linked to a team template or not","in":"query","name":"linked_to_team_template","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_used_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/EmailTemplate"},"type":"array"}}}}},"summary":"List email templates","tags":["Email Templates"]}},"/v2/email_templates/{id}.json":{"get":{"description":"Fetches an email template, by ID only.\n","parameters":[{"description":"EmailTemplate ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}}},"summary":"Fetch an email template","tags":["Email Templates"]}},"/v2/imports.json":{"get":{"description":"Fetches multiple imports.\n","parameters":[{"description":"IDs of imports to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"ID of users to fetch imports for. Using this filter will return an empty array for non-admin users who request other user's imports","in":"query","name":"user_ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to created_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Import"},"type":"array"}}}}},"summary":"List imports","tags":["Imports"]},"post":{"description":"Creates an import.\n","requestBody":{"$ref":"#/components/requestBodies/postV2ImportsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Create an import","tags":["Imports"]}},"/v2/imports/{id}.json":{"delete":{"description":"Deletes an import, by ID only. The associated people can be deleted as part of the deletion process.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Whether to delete people on this Import. Possible values are: [not present], all, single.\n\n'single' will delete people who are only present in this Import.\n'all' will delete people even if they are present in other Imports.\nNot specifying this parameter will not delete any people\n","in":"query","name":"undo","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The import has been deleted successfully"}},"summary":"Delete an import","tags":["Imports"]},"get":{"description":"Fetches an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Fetch an import","tags":["Imports"]},"put":{"description":"Updates an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postV2ImportsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Update an import","tags":["Imports"]}},"/v2/me.json":{"get":{"description":"Authenticated user information. This endpoint does not accept any parameters as it is\nrepresents your authenticated user. The \"Users\" resource provides user information\nfor other users on the team.\n","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}},"summary":"Fetch current user","tags":["Me"]}},"/v2/notes.json":{"get":{"description":"Fetches multiple note records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"Case insensitive type of item with which the note is associated. Value must be one of: person, account","in":"query","name":"associated_with_type","required":false,"schema":{"type":"string"}},{"description":"ID of the item with which the note is associated. The associated_with_type must also be present if this parameter is used","in":"query","name":"associated_with_id","required":false,"schema":{"type":"integer"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"IDs of notes to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Note"},"type":"array"}}}}},"summary":"List notes","tags":["Notes"]},"post":{"description":"Creates a note.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The content of the note","type":"string"},"associated_with_type":{"description":"Case insensitive type of item with which the note is associated. Value must be one of: person, account","type":"string"},"associated_with_id":{"description":"ID of the item with which the note is associated","type":"integer"},"skip_crm_sync":{"description":"Boolean indicating if the CRM sync should be skipped. No syncing will occur if true","type":"boolean"},"call_id":{"description":"ID of the call with which the note is associated. The call cannot already have a note","type":"integer"}},"required":["content","associated_with_type","associated_with_id"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Note"}}}}},"summary":"Create a note","tags":["Notes"]}},"/v2/notes/{id}.json":{"get":{"description":"Fetches a note, by ID only.\n","parameters":[{"description":"Note ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Note"}}}}},"summary":"Fetch a note","tags":["Notes"]},"put":{"description":"Updates a note. Any changes to the note or associated records will not reflect in Salesforce.com.\n","parameters":[{"description":"Note ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The content of the note","type":"string"},"call_id":{"description":"ID of the call with which the note is associated. The call cannot already have a note. If the note is associated to a call already, it will become associated to the requested call","type":"integer"}},"required":["content"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"summary":"Update a note","tags":["Notes"]}},"/v2/people.json":{"get":{"description":"Fetches multiple person records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of people to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters people by email address","in":"query","name":"email_addresses","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_contacted_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","n