---
title: "Connect Sugarcrm"
method: POST
path: "/integrations/sugarcrm/connect"
tags: ["Integrations"]
---

# Connect Sugarcrm

`POST /integrations/sugarcrm/connect`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/integrations/sugarcrm/connect`
- Auth: HTTP bearer

Connect SugarCRM. REACHES YOUR SUGARCRM to authenticate first.

409 when a SugarCRM connection already exists - rotate its credentials
with `/sugarcrm/reconnect` instead. 400 for an instance URL that does not
resolve to a public host, 401 when SugarCRM rejects the credentials.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SugarCrmConnectRequest: SugarCRM credentials for the password-grant connection. WRITE-ONLY: the username, password and client secret are stored encrypted and no operation returns them.
  - `instance_url` string, required: Your SugarCRM instance, e.g. https://acme.sugarondemand.com.
  - `username` string, required
  - `password` string, required
  - `client_id` string: OAuth client id configured in SugarCRM.
  - `client_secret` string: OAuth client secret, if your client id has one.

## Response `201`

Successful Response

- ApiResponseIntegrationOpPayload
  - `data` IntegrationOpPayload, required: An open envelope for one result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)