Skip to content

Get account and connections

When to use this guide: Use this endpoint as the first API call in a script or integration. It verifies the API key and returns the CRM connections that key can access.

GET /api/v1/me is an identity and access probe. It does not modify data and does not return secrets such as CRM refresh tokens.

The v1 API is read-only.

Request

GET /api/v1/me HTTP/1.1
Host: app.outboundsync.com
Authorization: Bearer osapi_<your-secret>

Field	Value
Method	`GET`
URL	`https://app.outboundsync.com/api/v1/me`
Authentication	`Authorization: Bearer osapi_<your-secret>`
Request body	None

curl

curl https://app.outboundsync.com/api/v1/me \
  -H "Authorization: Bearer osapi_<your-secret>"

JavaScript fetch

const response = await fetch('https://app.outboundsync.com/api/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.OUTBOUNDSYNC_API_KEY}`,
  },
});

if (!response.ok) {
  throw new Error(`OutboundSync API request failed: ${response.status}`);
}

const data = await response.json();
console.log(data.connections);

Response

{
  "account": {
    "id": 42,
    "email": "you@company.com"
  },
  "apiKey": {
    "name": "Production",
    "scopes": ["read"],
    "connectionScope": "account"
  },
  "connections": [
    {
      "id": 7,
      "crm": "HUBSPOT",
      "organizationId": "123",
      "organizationDomain": "acme.com"
    }
  ]
}

Response fields

Field	Type	Description
`account.id`	`number`	OutboundSync account owner ID for the API key.
`account.email`	`string \| null`	Account owner email, when available.
`apiKey.name`	`string`	The key name shown in the OutboundSync admin app.
`apiKey.scopes`	`string[]`	Current key scopes. New v1 keys use `["read"]`.
`apiKey.connectionScope`	`"account" \| "connection"`	Whether the key is account-wide or scoped to one CRM connection.
`connections[].id`	`number`	OutboundSync connection ID.
`connections[].crm`	`string`	CRM profile for the connection, such as `HUBSPOT` or `SALESFORCE`.
`connections[].organizationId`	`string \| null`	CRM organization ID, when OutboundSync has one.
`connections[].organizationDomain`	`string \| null`	CRM organization domain, when OutboundSync has one.

Connection scope behavior

An account-wide key returns every CRM connection where API access is enabled. A connection-scoped key returns only the selected connection.

If the key is valid but no accessible connection has API access enabled, OutboundSync returns 403.

Ask an AI coding assistant

Write a small Node.js function called getOutboundSyncConnections.
It should read OUTBOUNDSYNC_API_KEY from the environment, call GET https://app.outboundsync.com/api/v1/me, and return the connections array.
Handle 401, 403, and 429 with clear error messages based on https://outboundsync.com/docs/api/errors-and-rate-limits/.