AplasAplas API Reference

List all integrations

GET
/index/{indexId}/integration

Authorization

BearerAuth
AuthorizationBearer <token>

API authentication via Authorization: Bearer <your-api-key>. Obtain your API key from Config → API in the Aplas web app.

In: header

Path Parameters

indexId*string

The id of the containing index

Query Parameters

fields?string

Comma-separated list of additional fields to return. Use 'fields=*' to return all available fields. See the resource schema for fields you can request.

tagId?string

Filter by a particular integration tag id

Response Body

*/*

*/*

curl -X GET "https://api.au.aplas.com/api/v2/index/id/integration?fields=color%2Cdescription"
[
  {
    "id": "id",
    "name": "INT-001",
    "tagIds": [
      "id_tag"
    ],
    "sourceApplicationId": "id_source",
    "targetApplicationId": "id_target",
    "payload": "A Payload",
    "description": "More information",
    "status": "Standard",
    "customFieldA": "Custom Field Value",
    "customFieldB": [
      "alias1",
      "alias2"
    ],
    "componentIds": [
      "id_component_1",
      "id_component_2"
    ]
  }
]
{
  "code": 500,
  "message": "Internal server error"
}