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 (*Client) GetIngestrURI ¶
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 ¶
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=]
Click to show internal directories.
Click to hide internal directories.