GET
/
api
/
v3
/
axes
List Axes
curl --request GET \
  --url https://{host}/api/v3/axes \
  --header 'Authorization: <authorization>'
{
  "data": {
    "items": [
      {
        "id": 1,
        "name": "<string>",
        "url": "<string>",
        "multilingualName": "<string>",
        "position": 1,
        "parentAxisId": 1,
        "isActive": true,
        "isReadOnly": true,
        "isNNRelation": true,
        "level": 123,
        "parentAxis": {
          "id": 1,
          "name": "<string>",
          "url": "<string>",
          "multilingualName": "<string>",
          "position": 1,
          "parentAxisId": 1,
          "isActive": true,
          "isReadOnly": true,
          "isNNRelation": true,
          "level": 123
        },
        "childrenAxes": [
          {
            "id": 1,
            "name": "<string>",
            "url": "<string>",
            "multilingualName": "<string>",
            "position": 1,
            "parentAxisId": 1,
            "isActive": true,
            "isReadOnly": true,
            "isNNRelation": true,
            "level": 123
          }
        ]
      }
    ]
  }
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
id
integer[]

Filter on axes unique identifiers.

​
isActive
boolean
default:true

Filter on axes active status.

​
paging
string
required

{offset},{limit}. Defaults to 0,1000.

Example:

"100,0"

Response

200
application/json

OK

The response is of type object.