List OAuth Connections

Changed on
get/oauth_connections

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/oauth_connections
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.instring[]

Filter to OAuth Connections by their status. By default, return only the active ones. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

oauth_application_idstring

Filter results to only include OAuth Connections for a specific OAuth Application.

Response

OAuth Connection List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "deleted_at": null,
      "group_id": "group_1g4mhziu6kvrs3vz35um",
      "id": "connection_dauknoksyr4wilz4e6my",
      "oauth_application_id": "application_gj9ufmpgh5i56k4vyriy",
      "status": "active",
      "type": "oauth_connection"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status