openapi: 3.2.0 info: version: v1 title: Datto|Autotask PSA Rest Company Contacts Child API servers: - url: https://webservices2.autotask.net/ATServicesRest tags: - name: CompanyContactsChild paths: /V1.0/Companies/{parentId}/Contacts: get: tags: - CompanyContactsChild operationId: CompanyContactsChild_Query parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QueryActionResult_ContactModel_Contact' text/json: schema: $ref: '#/components/schemas/QueryActionResult_ContactModel_Contact' '401': description: Unauthorized '403': description: Forbidden put: tags: - CompanyContactsChild operationId: CompanyContactsChild_UpdateEntity parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OperationResultModel' text/json: schema: $ref: '#/components/schemas/OperationResultModel' '401': description: Unauthorized '403': description: Forbidden requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactModel' required: true post: tags: - CompanyContactsChild operationId: CompanyContactsChild_CreateEntity parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OperationResultModel' text/json: schema: $ref: '#/components/schemas/OperationResultModel' '401': description: Unauthorized '403': description: Forbidden requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactModel' required: true patch: tags: - CompanyContactsChild operationId: CompanyContactsChild_PatchEntity parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OperationResultModel' text/json: schema: $ref: '#/components/schemas/OperationResultModel' '401': description: Unauthorized '403': description: Forbidden requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactModel' required: true /V1.0/Companies/{parentId}/Contacts/{id}: get: tags: - CompanyContactsChild operationId: CompanyContactsChild_QueryItem parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ItemQueryResultModel_ContactModel_Contact' text/json: schema: $ref: '#/components/schemas/ItemQueryResultModel_ContactModel_Contact' '401': description: Unauthorized '403': description: Forbidden delete: tags: - CompanyContactsChild operationId: CompanyContactsChild_DeleteEntity parameters: - name: parentId in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OperationResultModel' text/json: schema: $ref: '#/components/schemas/OperationResultModel' '401': description: Unauthorized '403': description: Forbidden /V1.0/Companies/{parentId}/Contacts/entityInformation: get: tags: - CompanyContactsChild operationId: CompanyContactsChild_QueryEntityInformation parameters: - name: parentId in: path required: true schema: type: string - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EntityInformationResultModel' text/json: schema: $ref: '#/components/schemas/EntityInformationResultModel' '401': description: Unauthorized '403': description: Forbidden /V1.0/Companies/{parentId}/Contacts/entityInformation/fields: get: tags: - CompanyContactsChild operationId: CompanyContactsChild_QueryFieldDefinitions parameters: - name: parentId in: path required: true schema: type: string - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FieldInformationResultModel' text/json: schema: $ref: '#/components/schemas/FieldInformationResultModel' '401': description: Unauthorized '403': description: Forbidden /V1.0/Companies/{parentId}/Contacts/entityInformation/userDefinedFields: get: tags: - CompanyContactsChild operationId: CompanyContactsChild_QueryUserDefinedFieldDefinitions parameters: - name: parentId in: path required: true schema: type: string - name: ApiIntegrationCode in: header description: API Integration Code required: true schema: type: string - name: UserName in: header description: User Name required: true schema: type: string - name: Secret in: header description: Secret required: true schema: type: string - name: ImpersonationResourceId in: header description: Impersonation Resource Key required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserDefinedFieldInformationResultModel' text/json: schema: $ref: '#/components/schemas/UserDefinedFieldInformationResultModel' '401': description: Unauthorized '403': description: Forbidden components: schemas: ParameterExpression: type: object properties: type: type: string readOnly: true nodeType: enum: - Add - AddChecked - And - AndAlso - ArrayLength - ArrayIndex - Call - Coalesce - Conditional - Constant - Convert - ConvertChecked - Divide - Equal - ExclusiveOr - GreaterThan - GreaterThanOrEqual - Invoke - Lambda - LeftShift - LessThan - LessThanOrEqual - ListInit - MemberAccess - MemberInit - Modulo - Multiply - MultiplyChecked - Negate - UnaryPlus - NegateChecked - New - NewArrayInit - NewArrayBounds - Not - NotEqual - Or - OrElse - Parameter - Power - Quote - RightShift - Subtract - SubtractChecked - TypeAs - TypeIs - Assign - Block - DebugInfo - Decrement - Dynamic - Default - Extension - Goto - Increment - Index - Label - RuntimeVariables - Loop - Switch - Throw - Try - Unbox - AddAssign - AndAssign - DivideAssign - ExclusiveOrAssign - LeftShiftAssign - ModuloAssign - MultiplyAssign - OrAssign - PowerAssign - RightShiftAssign - SubtractAssign - AddAssignChecked - MultiplyAssignChecked - SubtractAssignChecked - PreIncrementAssign - PreDecrementAssign - PostIncrementAssign - PostDecrementAssign - TypeEqual - OnesComplement - IsTrue - IsFalse type: string readOnly: true name: type: string readOnly: true isByRef: type: boolean readOnly: true canReduce: type: boolean readOnly: true UserDefinedFieldInformationResultModel: type: object properties: fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true QueryActionResult_ContactModel_Contact: type: object properties: items: type: array items: $ref: '#/components/schemas/ContactModel' pageDetails: $ref: '#/components/schemas/PagingModel' ItemQueryResultModel_ContactModel_Contact: type: object properties: item: $ref: '#/components/schemas/ContactModel' FieldInformationModel: type: object properties: name: type: string dataType: type: string length: format: int32 type: integer isRequired: type: boolean isReadOnly: type: boolean isQueryable: type: boolean isReference: type: boolean referenceEntityType: type: string isPickList: type: boolean picklistValues: type: array items: $ref: '#/components/schemas/PickListValue' picklistParentValueField: type: string isSupportedWebhookField: $ref: '#/components/schemas/Object' FieldInformationResultModel: type: object properties: fields: type: array items: $ref: '#/components/schemas/FieldInformationModel' readOnly: true EntityInformationResultModel: type: object properties: info: $ref: '#/components/schemas/EntityInformationModel' readOnly: true Expression_Func_Contact_Int64: type: object properties: type: type: string readOnly: true nodeType: enum: - Add - AddChecked - And - AndAlso - ArrayLength - ArrayIndex - Call - Coalesce - Conditional - Constant - Convert - ConvertChecked - Divide - Equal - ExclusiveOr - GreaterThan - GreaterThanOrEqual - Invoke - Lambda - LeftShift - LessThan - LessThanOrEqual - ListInit - MemberAccess - MemberInit - Modulo - Multiply - MultiplyChecked - Negate - UnaryPlus - NegateChecked - New - NewArrayInit - NewArrayBounds - Not - NotEqual - Or - OrElse - Parameter - Power - Quote - RightShift - Subtract - SubtractChecked - TypeAs - TypeIs - Assign - Block - DebugInfo - Decrement - Dynamic - Default - Extension - Goto - Increment - Index - Label - RuntimeVariables - Loop - Switch - Throw - Try - Unbox - AddAssign - AndAssign - DivideAssign - ExclusiveOrAssign - LeftShiftAssign - ModuloAssign - MultiplyAssign - OrAssign - PowerAssign - RightShiftAssign - SubtractAssign - AddAssignChecked - MultiplyAssignChecked - SubtractAssignChecked - PreIncrementAssign - PreDecrementAssign - PostIncrementAssign - PostDecrementAssign - TypeEqual - OnesComplement - IsTrue - IsFalse type: string readOnly: true parameters: type: array items: $ref: '#/components/schemas/ParameterExpression' readOnly: true name: type: string readOnly: true body: $ref: '#/components/schemas/Expression' readOnly: true returnType: type: string readOnly: true tailCall: type: boolean readOnly: true canReduce: type: boolean readOnly: true UserDefinedField: type: object properties: name: type: string value: type: string PickListValue: type: object properties: value: type: string label: type: string isDefaultValue: type: boolean sortOrder: format: int32 type: integer parentValue: type: string isActive: type: boolean isSystem: type: boolean Expression: type: object properties: nodeType: enum: - Add - AddChecked - And - AndAlso - ArrayLength - ArrayIndex - Call - Coalesce - Conditional - Constant - Convert - ConvertChecked - Divide - Equal - ExclusiveOr - GreaterThan - GreaterThanOrEqual - Invoke - Lambda - LeftShift - LessThan - LessThanOrEqual - ListInit - MemberAccess - MemberInit - Modulo - Multiply - MultiplyChecked - Negate - UnaryPlus - NegateChecked - New - NewArrayInit - NewArrayBounds - Not - NotEqual - Or - OrElse - Parameter - Power - Quote - RightShift - Subtract - SubtractChecked - TypeAs - TypeIs - Assign - Block - DebugInfo - Decrement - Dynamic - Default - Extension - Goto - Increment - Index - Label - RuntimeVariables - Loop - Switch - Throw - Try - Unbox - AddAssign - AndAssign - DivideAssign - ExclusiveOrAssign - LeftShiftAssign - ModuloAssign - MultiplyAssign - OrAssign - PowerAssign - RightShiftAssign - SubtractAssign - AddAssignChecked - MultiplyAssignChecked - SubtractAssignChecked - PreIncrementAssign - PreDecrementAssign - PostIncrementAssign - PostDecrementAssign - TypeEqual - OnesComplement - IsTrue - IsFalse type: string readOnly: true type: type: string readOnly: true canReduce: type: boolean readOnly: true Object: type: object properties: {} Field: type: object properties: name: type: string label: type: string type: type: string length: format: int32 type: integer description: type: string isRequired: type: boolean isReadOnly: type: boolean isQueryable: type: boolean isReference: type: boolean referenceEntityType: type: string isPickList: type: boolean picklistValues: type: array items: $ref: '#/components/schemas/PickListValue' picklistParentValueField: type: string defaultValue: type: string isSupportedWebhookField: $ref: '#/components/schemas/Object' RestUserAccessLevel: type: object properties: {} EntityInformationModel: type: object properties: name: type: string readOnly: true canCreate: type: boolean readOnly: true canDelete: type: boolean readOnly: true canQuery: type: boolean readOnly: true canUpdate: type: boolean readOnly: true userAccessForCreate: $ref: '#/components/schemas/RestUserAccessLevel' readOnly: true userAccessForDelete: $ref: '#/components/schemas/RestUserAccessLevel' readOnly: true userAccessForQuery: $ref: '#/components/schemas/RestUserAccessLevel' readOnly: true userAccessForUpdate: $ref: '#/components/schemas/RestUserAccessLevel' readOnly: true hasUserDefinedFields: type: boolean readOnly: true supportsWebhookCallouts: type: boolean readOnly: true OperationResultModel: type: object properties: itemId: $ref: '#/components/schemas/Object' PagingModel: type: object properties: count: format: int32 type: integer requestCount: format: int32 type: integer readOnly: true prevPageUrl: type: string nextPageUrl: type: string ContactModel: type: object properties: id: format: int64 type: integer additionalAddressInformation: type: string addressLine: type: string addressLine1: type: string alternatePhone: type: string apiVendorID: format: int32 type: integer bulkEmailOptOutTime: format: date-time type: string city: type: string companyID: format: int32 type: integer companyLocationID: format: int32 type: integer countryID: format: int32 type: integer createDate: format: date-time type: string emailAddress: type: string emailAddress2: type: string emailAddress3: type: string extension: type: string externalID: type: string facebookUrl: type: string faxNumber: type: string firstName: type: string impersonatorCreatorResourceID: format: int32 type: integer isActive: format: int32 type: integer isOptedOutFromBulkEmail: type: boolean lastActivityDate: format: date-time type: string lastModifiedDate: format: date-time type: string lastName: type: string linkedInUrl: type: string middleInitial: type: string mobilePhone: type: string namePrefix: format: int32 type: integer nameSuffix: format: int32 type: integer note: type: string receivesEmailNotifications: type: boolean phone: type: string primaryContact: type: boolean billingContact: type: boolean roomNumber: type: string solicitationOptOut: type: boolean solicitationOptOutTime: format: date-time type: string state: type: string surveyOptOut: type: boolean title: type: string twitterUrl: type: string zipCode: type: string soapParentPropertyId: $ref: '#/components/schemas/Expression_Func_Contact_Int64' readOnly: true userDefinedFields: type: array items: $ref: '#/components/schemas/UserDefinedField'