twenty

package
v0.11.746 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(c Config) (*Client, error)

func (*Client) GetIngestrURI

func (c *Client) GetIngestrURI() (string, error)

type Config

type Config struct {
	// Host is the workspace host, e.g. api.twenty.com for Twenty Cloud or your own
	// domain for a self-hosted instance. Required.
	Host string
	// APIKey is created in the workspace under Settings > API & Webhooks. Required.
	APIKey string
	// Scheme is the transport used to reach the workspace, https or http.
	// Optional, defaults to https.
	Scheme string
	// BasePath is where the REST API is mounted. Optional, defaults to /rest.
	BasePath string
	// PageSize is the number of rows per request. Optional, defaults to and is
	// capped at 200.
	PageSize *int
	// RateLimit is the number of requests per second. Optional, defaults to 1.33
	// (80% of Twenty's documented 100 requests/minute).
	RateLimit *float64
	// IncludeDeleted controls whether a second pass re-reads soft-deleted records.
	// Optional, defaults to true.
	IncludeDeleted *bool
}

Config holds the settings required to connect to a Twenty CRM workspace.

func (*Config) GetIngestrURI

func (c *Config) GetIngestrURI() (string, error)

GetIngestrURI builds the ingestr source URI for Twenty CRM. Format: twenty://<host>?api_key=<api_key>[&scheme=&base_path=&page_size=&rate_limit=&include_deleted=]

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL