GET
/
projects
/
{projectIdOrName}
/
connections
/
{connectionId}
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "connection-123",
  "projectId": "project-456",
  "provider": "salesforce",
  "providerApp": {
    "id": "provider-app-123",
    "projectId": "project-456",
    "externalRef": "external-id-123",
    "provider": "salesforce",
    "clientId": "client-id-123",
    "scopes": [
      [
        "oauth",
        "offline",
        "crm.read"
      ]
    ],
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z"
  },
  "group": {
    "groupRef": "group-123",
    "groupName": "Super Customer",
    "projectId": "project-456",
    "createTime": "2023-07-13T21:34:44.816354Z",
    "updateTime": "2023-07-13T21:34:44.816354Z"
  },
  "consumer": {
    "consumerRef": "consumer-123",
    "consumerName": "Super Customer",
    "projectId": "project-456",
    "createTime": "2023-07-13T21:34:44.816354Z",
    "updateTime": "2023-07-13T21:34:44.816354Z"
  },
  "providerWorkspaceRef": "provider-workspace-123",
  "providerConsumerRef": "provider-consumer-123",
  "createTime": "2023-07-13T21:34:44.816354Z",
  "updateTime": "2023-07-13T21:34:44.816354Z",
  "authScheme": "oauth2/authorizationCode",
  "status": "working",
  "oauth2AuthorizationCode": {
    "accessToken": {
      "token": "<string>",
      "issuedAt": "2024-04-22T18:55:28.456076Z",
      "expiresAt": "2024-10-22T18:55:28.456076Z"
    },
    "refreshToken": {
      "token": "<string>",
      "issuedAt": "2024-04-22T18:55:28.456076Z",
      "expiresAt": "2024-10-22T18:55:28.456076Z"
    },
    "scopes": [
      "<string>"
    ]
  },
  "apiKey": "api-key-123",
  "providerMetadata": {}
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

​
connectionId
string
required

Query Parameters

​
includeCreds
boolean

Whether to include the credentials in the response. Only access token will be included. Default is false.

​
includeRefreshToken
boolean

Whether to include the refresh token in credentials in the response along with access token. If true, the includeCreds query parameter will be ignored. Default is false.

​
refresh
enum<string>

Whether to refresh the access token. If value is ifExpired, the access token will be refreshed only if it has expired. If value is force, the access token will be refreshed regardless of its expiration.

Available options:
force,
ifExpired

Response

200
application/json

Connection

The response is of type object.