n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/highLevel/v2/resource_contact/operation_get.ts

Base nodes of n8n

/**
 * HighLevel Node - Version 2
 * Discriminator: resource=contact, operation=get
 */


interface Credentials {
  highLevelOAuth2Api: CredentialReference;
}

export type HighLevelV2ContactGetParams = {
  resource: 'contact';
  operation: 'get';
/**
 * Contact ID
 */
    contactId?: string | Expression<string> | PlaceholderValue;
  requestOptions?: {
    /** Batching
     * @default {"batch":{}}
     */
    batching?: {
        /** Batching
     */
    batch?: {
      /** Input will be split in batches to throttle requests. -1 for disabled. 0 will be treated as 1.
       * @default 50
       */
      batchSize?: number | Expression<number>;
      /** Time (in milliseconds) between each batch of requests. 0 for disabled.
       * @default 1000
       */
      batchInterval?: number | Expression<number>;
    };
  };
    /** Whether to accept the response even if SSL certificate validation is not possible
     * @default false
     */
    allowUnauthorizedCerts?: boolean;
    /** HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
     */
    proxy?: string | Expression<string> | PlaceholderValue;
    /** Time in ms to wait for the server to send response headers (and start the response body) before aborting the request
     * @default 10000
     */
    timeout?: number | Expression<number>;
  };
};

export type HighLevelV2ContactGetOutput = {
  additionalPhones?: Array<{
    phone?: string;
    phoneLabel?: string;
  }>;
  attributionSource?: {
    medium?: string;
    sessionSource?: string;
  };
  country?: string;
  createdBy?: {
    channel?: string;
    source?: string;
    sourceId?: string;
    timestamp?: string;
  };
  customFields?: Array<{
    id?: string;
  }>;
  dateAdded?: string;
  dateUpdated?: string;
  email?: string;
  emailLowerCase?: string;
  firstName?: string;
  firstNameLowerCase?: string;
  fullNameLowerCase?: string;
  id?: string;
  lastName?: string;
  lastNameLowerCase?: string;
  locationId?: string;
  phone?: string;
  tags?: Array<string>;
  type?: string;
};

export type HighLevelV2ContactGetNode = {
  type: 'n8n-nodes-base.highLevel';
  version: 2;
  credentials?: Credentials;
  config: NodeConfig<HighLevelV2ContactGetParams>;
  output?: Items<HighLevelV2ContactGetOutput>;
};