List action types

GET

/v1/action-types

const url = 'https://api.aerandil.com/v1/action-types';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/action-types \
  --header 'Authorization: Bearer <token>'

Schema-discovery surface for actions. Each entry surfaces the target object type, parameter count, and declared effects (create/modify/delete/link/modify_link/unlink) so a UI can render an action picker without walking /v1/openapi.json.

Authorizations

aerandil_oauth
objects:read

Responses

200

Sorted summary list of every registered action type.

application/json

object

data

required

Array<object>

object

api_name

required

string

description

string

nullable

display_name

required

string

effects

required

Array

One of: discriminator: kind

object

kind

required

string

Allowed value: create

Allowed values: create

object_type

required

string

parameter_count

required

integer

target_object_type

Bound target object type for targeted actions. Untargeted actions (creates) leave it null.

string

nullable

next_page_token

Opaque cursor for the next page (AIP-158). Reserved for future growth; v1 returns null because the registry size is bounded.

string

nullable

Example

{
  "data": [
    {
      "effects": [
        {
          "kind": "create"
        }
      ]
    }
  ]
}