Skip to main content
GET
/
actions
List all connectors & actions metadata
curl --request GET \
  --url https://api.stackone.com/actions \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": "<string>",
  "data": [
    {
      "account_id": "<string>",
      "integration_id": "<string>",
      "connector_profile_id": "<string>",
      "version": "<string>",
      "name": "<string>",
      "key": "<string>",
      "icon": "<string>",
      "description": "<string>",
      "release_stage": "<string>",
      "categories": [
        "hris",
        "ats"
      ],
      "authentication": [
        {
          "type": "<string>",
          "label": "<string>",
          "key": "<string>",
          "required_scopes": [
            "<string>"
          ],
          "support": {
            "link": "<string>",
            "description": "<string>",
            "guides": {
              "config": {
                "sections": [
                  {
                    "title": "<string>",
                    "content": "<string>",
                    "list": [
                      "<string>"
                    ],
                    "steps": [
                      {
                        "title": "<string>",
                        "content": "<string>",
                        "list": [
                          "<string>"
                        ],
                        "displayScopes": true,
                        "applicableScopes": [
                          "<string>"
                        ],
                        "image": {
                          "src": "<string>",
                          "alt": "<string>"
                        }
                      }
                    ],
                    "applicableScopes": [
                      "<string>"
                    ],
                    "image": {
                      "src": "<string>",
                      "alt": "<string>"
                    }
                  }
                ],
                "warning": "<string>"
              },
              "setup": {
                "sections": [
                  {
                    "title": "<string>",
                    "content": "<string>",
                    "list": [
                      "<string>"
                    ],
                    "steps": [
                      {
                        "title": "<string>",
                        "content": "<string>",
                        "list": [
                          "<string>"
                        ],
                        "displayScopes": true,
                        "applicableScopes": [
                          "<string>"
                        ],
                        "image": {
                          "src": "<string>",
                          "alt": "<string>"
                        }
                      }
                    ],
                    "applicableScopes": [
                      "<string>"
                    ],
                    "image": {
                      "src": "<string>",
                      "alt": "<string>"
                    }
                  }
                ],
                "warning": "<string>"
              }
            }
          }
        }
      ],
      "scope_definitions": [
        {
          "name": "<string>",
          "description": "<string>",
          "includes": [
            "<string>"
          ]
        }
      ],
      "actions": [
        {
          "id": "<string>",
          "label": "<string>",
          "description": "<string>",
          "schema_type": "<string>",
          "tags": [
            "<string>"
          ],
          "authentication": [
            {
              "type": "<string>",
              "label": "<string>",
              "key": "<string>",
              "required_scopes": [
                "<string>"
              ],
              "support": {
                "link": "<string>",
                "description": "<string>",
                "guides": {
                  "config": {
                    "sections": [
                      {
                        "title": "<string>",
                        "content": "<string>",
                        "list": [
                          "<string>"
                        ],
                        "steps": [
                          {
                            "title": "<string>",
                            "content": "<string>",
                            "list": [
                              "<string>"
                            ],
                            "displayScopes": true,
                            "applicableScopes": [
                              "<string>"
                            ],
                            "image": {
                              "src": "<string>",
                              "alt": "<string>"
                            }
                          }
                        ],
                        "applicableScopes": [
                          "<string>"
                        ],
                        "image": {
                          "src": "<string>",
                          "alt": "<string>"
                        }
                      }
                    ],
                    "warning": "<string>"
                  },
                  "setup": {
                    "sections": [
                      {
                        "title": "<string>",
                        "content": "<string>",
                        "list": [
                          "<string>"
                        ],
                        "steps": [
                          {
                            "title": "<string>",
                            "content": "<string>",
                            "list": [
                              "<string>"
                            ],
                            "displayScopes": true,
                            "applicableScopes": [
                              "<string>"
                            ],
                            "image": {
                              "src": "<string>",
                              "alt": "<string>"
                            }
                          }
                        ],
                        "applicableScopes": [
                          "<string>"
                        ],
                        "image": {
                          "src": "<string>",
                          "alt": "<string>"
                        }
                      }
                    ],
                    "warning": "<string>"
                  }
                }
              }
            }
          ],
          "action_details": {},
          "required_scopes": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
page_size
string | null

The number of results per page (default value is 25)

​
next
string | null

The unified cursor

​
group_by
string | null
default:connector

The relation to group the results by

Example:
["connector"]
​
filter
object

Actions Metadata filters

​
include
enum<string>[] | null

Additional data to include in the response

Available options:
action_details,
authentication_guides,
event_guides
Example:
[
  "action_details",
  "authentication_guides",
  "event_guides"
]
​
search
string | null

Text search across provider names, action labels, and action descriptions

Example:

"employee"

​
exclude
enum<string>[] | null

Data to exclude from the response

Available options:
actions
Example:
["actions"]

Response

List of actions metadata

​
next
string | null

Cursor for fetching the next page of results

​
data
object[] | null

The list of actions metadata