Skip to main content
GET
/
projects
/
{projectIdOrName}
/
provider-apps
List provider apps
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/provider-apps \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "provider-app-123",
    "projectId": "project-456",
    "provider": "salesforce",
    "clientId": "client-id-123",
    "createTime": "2023-11-07T05:31:56Z",
    "externalRef": "external-id-123",
    "scopes": [
      [
        "oauth",
        "offline",
        "crm.read"
      ]
    ],
    "updateTime": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

TThe Ampersand project ID or project name.

Response

List of provider apps

​
id
string
required

The provider app ID.

Example:

"provider-app-123"

​
projectId
string
required

The Ampersand project ID.

Example:

"project-456"

​
provider
string
required

The SaaS provider that this app connects to.

Example:

"salesforce"

​
clientId
string
required

The OAuth client ID for this app.

Example:

"client-id-123"

​
createTime
string<date-time>
required

The time the provider app was created.

​
externalRef
string

The ID used by the provider to identify the app (optional).

Example:

"external-id-123"

​
scopes
string[]

The OAuth scopes for this app.

​
updateTime
string<date-time>

The time the provider app was updated.