Connections

List connections

Changed on

Returns a paginated, filterable list of connections in the organization. Supply teamId in the property query to restrict results to one team.

get/api/v3/connections

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/connections
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Query parameters

propertystring[] 
Property filters. Can be repeated and are AND-ed together.

Allowed fields:
- id
- name
- accountName
- accountType
- expire
- teamId
- scopesCount
- editable
- uid
- environmentType
- authenticationType

Supported operators:
- ==  (equals)
- !=  (not equals)
- >   (greater than)
- >=  (greater than or equal)
- <   (less than)
- <=  (less than or equal)
- ~   (case-insensitive regex match)

Special cases:
- field           → field exists
- !field          → field does not exist

[
  "teamId==3849"
]
startstring

Paging cursor. Must correspond to "orderby" field and used only when it is set.

limitinteger

Maximum number of items to return. Must be a positive integer. Range 1–200.

orderbystring
Example:+id

Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, accountName, expire.

Response

Successfully retrieved paged connections

Example response

{
  "_page": {
    "orderby": "+id",
    "start": "123",
    "next": "124",
    "count": 100
  },
  "_links": {
    "next": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304",
    "page": "/v3/{{resource}}{?orderby,start,limit,property,type}"
  },
  "items": [
    {
      "id": 10752,
      "name": "My Workfront connection",
      "accountName": "adobe-workfront-oauth2",
      "accountLabel": "Adobe Workfront auth",
      "accountType": "oauth",
      "metadata": {
        "type": "text",
        "value": "John | my.workfront.com"
      },
      "teamId": 16496,
      "theme": "#db492b",
      "scopesCount": 3,
      "scoped": true,
      "environmentType": "nonproduction",
      "authenticationType": "personalaccount",
      "createdAt": "2024-03-15T10:22:00.000Z"
    }
  ]
}

Changes

  • 7c7767c7a45fRevision changes
    • info

      removed the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

  • 15ef44a12969Revision changes
    • info

      endpoint added