List Access Sets

Restrict list item visibility per user or group

List all access sets

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Responses

200

All access sets

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

get/{app_short}/list/accessset

HTTPcURLJavaScriptPython

GET /{app_short}/list/accessset HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

All access sets

{
  "listaccesssets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "users": [
        "text"
      ],
      "groups": [],
      "root_id": 1,
      "lists": [
        1
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Create an access set

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

Root list node identifier

Body

application/json

namestringRequired

groupsinteger[]Optional

usersinteger[]Optional

listsinteger[]Optional

Responses

200

Access set created

application/json

idstring · uuidOptional

post/{app_short}/list/{root_id}/accessset

HTTPcURLJavaScriptPython

POST /{app_short}/list/{root_id}/accessset HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "name": "text",
  "groups": [
    1
  ],
  "users": [
    1
  ],
  "lists": [
    1
  ]
}

200

Access set created

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Get access sets for a list and user

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

user_idintegerRequired

Responses

200

Access set UUIDs for this user and list

application/json

string · uuid[]Optional

get/{app_short}/list/{list_id}/accessset/user/{user_id}

HTTPcURLJavaScriptPython

GET /{app_short}/list/{list_id}/accessset/user/{user_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Access set UUIDs for this user and list

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Get access set details

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

Responses

200

Access set full details

application/json

idstring · uuidOptional

namestringOptional

get/{app_short}/list/{list_id}/accessset/{list_access_set_id}

HTTPcURLJavaScriptPython

GET /{app_short}/list/{list_id}/accessset/{list_access_set_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Access set full details

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "users": [
    {
      "id": 1,
      "email": "[e-mail]",
      "first_name": "text",
      "last_name": "text",
      "groups": [],
      "system_groups": []
    }
  ],
  "groups": [],
  "root_id": {
    "id": 1,
    "name": "text",
    "level": 1,
    "position": 1,
    "has_image": true
  },
  "lists": [
    {
      "id": 1,
      "root_id": 1,
      "parent_id": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "name": "text",
      "has_image": true,
      "level": 1,
      "position": 1,
      "external_id": "text",
      "url": "text",
      "functionnal_status_color": "text"
    }
  ]
}

Delete an access set

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

Responses

204

Access set deleted

No content

delete/{app_short}/list/{list_id}/accessset/{list_access_set_id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/list/{list_id}/accessset/{list_access_set_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Access set deleted

No content

Generate access set dependencies

post

Immediately recalculates internal access set dependencies. Runs automatically every 5 minutes; call manually after batch changes.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

Responses

200

Dependencies regenerated

No content

post/{app_short}/list/{list_id}/accessset/{list_access_set_id}/generate

HTTPcURLJavaScriptPython

POST /{app_short}/list/{list_id}/accessset/{list_access_set_id}/generate HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Dependencies regenerated

No content

Get access set entity list (users / groups / lists)

get

Use users, groups, or lists as the entity path value.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

entitystring · enumRequiredPossible values:

Responses

200

Array of the requested entity type

application/json

itemsanyOptional

get/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}

HTTPcURLJavaScriptPython

GET /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of the requested entity type

[]

Add an entity to an access set

put

Adds a user, group, or list item to the access set.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

entitystring · enumRequiredPossible values:

entity_idintegerRequired

Responses

200

Entity added

No content

put/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id}

HTTPcURLJavaScriptPython

PUT /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Entity added

No content

Remove an entity from an access set

delete

Removes a user, group, or list item from the access set.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

list_access_set_idstring · uuidRequired

entitystring · enumRequiredPossible values:

entity_idintegerRequired

Responses

204

Entity removed

No content

delete/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Entity removed

No content