SugarCRM

Use the @bijection/connectors/sugarcrm entrypoint to declare SugarCRM resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Module records	`pull`	date_modified windows with a deleted=true phase, unconditional PUT

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Module records

pull: date_modified windows with a deleted=true phase, unconditional PUT

The following example matches configuration standard.

import { sugarCrm } from "@bijection/connectors/sugarcrm";
import { makeFunctionReference } from "bijection/server";

export const accounts = sugarCrm.records.pull({
  module: "Accounts",
  fields: ["name"],
  governingRule: makeFunctionReference<"query", any, [null]>("crm:canUpdate"),
});

Inferred record types

Resource without an operational record table

The function references identify application policy queries. Implement those policies in your application; the references alone grant no authority.

Configuration: standard

Case: sugarcrm/records/pull/standard. Connection and resource configuration are declared by this exact case. Credential kind: sugarcrm. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`endpoint`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "sugarcrm",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "sugarcrm",
    "connection_fields": [
      "endpoint"
    ],
    "address": {
      "kind": "setup",
      "field": "endpoint"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "endpoint": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "changes": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "deletions": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "record": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange changes",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange deletions",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.3",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange record",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2",
          "acquire.3"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {
    "update": {
      "target": "records",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    }
  }
}

Commands

Command	Target	Condition	Delivery
`update`	records	Unconditional	Single dispatch attempt

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "changes": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "deletions": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "record": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange changes",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange deletions",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.3",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange record",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2",
                "acquire.3"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {
          "update": {
            "target": "records",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          }
        }
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {
    "update": {
      "target": "records",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    }
  }
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
command-response-lost	{“kind”:“command”,“name”:“update”}	Native test: integrations/listeners/calendar_repair_preserves_accepted_responsibility (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/sugarcrm/fixtures/identity.json	passed (2026-10-24T21:36:12.436Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: readOnly

Case: sugarcrm/records/pull/readOnly. Connection and resource configuration are declared by this exact case. Credential kind: sugarcrm. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`endpoint`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "sugarcrm",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "sugarcrm",
    "connection_fields": [
      "endpoint"
    ],
    "address": {
      "kind": "setup",
      "field": "endpoint"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "endpoint": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "changes": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "deletions": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "record": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange changes",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange deletions",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.3",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange record",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2",
          "acquire.3"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "changes": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "deletions": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "record": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange changes",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange deletions",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.3",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange record",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2",
                "acquire.3"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/sugarcrm/fixtures/identity.json	passed (2026-10-24T21:36:12.436Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. The connection holds a sugarcrm credential; setup endpoint is the REST base including its version, such as https://acme.sugarondemand.com/rest/v11_24/. Sugar takes its access token in an OAuth-Token header. The credential is a managed oauth_refresh envelope over the user’s refresh token whose protocol names that header; Sugar’s stock client is public (sugar, no secret):

{
  "kind": "oauth_refresh",
  "protocol": { "authentication": "public_client", "bearer_header": "oauth-token" },
  "token_endpoint": "https://acme.sugarondemand.com/rest/v11_24/oauth2/token",
  "client_id": "sugar",
  "client_secret": "",
  "refresh_token": "…",
  "refresh_context": { "kind": "none" },
  "allowed_resource_origins": ["https://acme.sugarondemand.com"]
}

Sugar keeps one session per user and platform; the refresh request sends no platform, and whether Sugar then renews under the platform the grant was issued for is unestablished. Sugar names no instance identity, so the connection is its own account namespace. records.pull reads <module>/filter with date_modified $gte, ordered date_modified:ASC,id:ASC, 100 rows by offset until next_offset is -1, re-asking from one second before the latest date_modified read. The pass then reads the same listing with deleted=true; a row whose deleted is true withdraws the record. Each finished pass carries the latest modification and deletion; the next starts five minutes before them. date_modified is kept as Sugar spells it, the version. update is an unconditional single-attempt PUT. Nothing here has run against SugarCRM or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Module records

pull: date_modified windows with a deleted=true phase, unconditional PUT

Configuration: standard

Configuration: readOnly

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Module records

​pull: date_modified windows with a deleted=true phase, unconditional PUT

​Configuration: standard

​Configuration: readOnly

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Module records

pull: date_modified windows with a deleted=true phase, unconditional PUT

Configuration: standard

Configuration: readOnly

Provider guidance

Provider references

Source and evidence