Ayla Networks Collections.json API
The Collections.json API from Ayla Networks — 1 operation(s) for collections.json.
The Collections.json API from Ayla Networks — 1 operation(s) for collections.json.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ayla-networks:ayla-networks-collections-json-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: groups-scenes Collections.json API
version: '1.0'
servers:
- url: https://gss-dev.aylanetworks.com/groupsceneservice/v1/
security:
- sec0: []
tags:
- name: Collections.json
paths:
/collections.json:
get:
summary: Retrieve collections
description: This API is used to retrieve the list of collections belonging to the user.
operationId: retrieve-collections
parameters:
- name: type
in: query
description: Type of the collection. It can be either "GROUP" or "SCENE". The parameter value is case insensitive.
schema:
type: string
- name: paginated
in: query
description: Indicate if pagination is required or not. True or fale.
schema:
type: boolean
- name: per_page
in: query
description: Indicates number of items to be displayed per page.
schema:
type: integer
format: int32
- name: page
in: query
description: Page number to be displayed.
schema:
type: integer
format: int32
- name: sort_by
in: query
description: Field name. Based on this field, the results are sorted.
schema:
type: string
default: created_at
- name: order_by
in: query
description: asc or desc
schema:
type: string
- name: custom_attribute
in: query
description: 'Key-value pair. The API will return all the collections matching this "custom_attribute" key-value pair. Below are the examples for the "custom_attribute" parameter value:<br>1. color~blue<br>2. color~%23F08080.<br>*NOTE*: The key-value pair is separated by the “~” symbol and should be encoded.'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
examples:
Result:
value:
collections:
- collection_uuid: 8ae79d4b-bc40-4bc3-889e-7cbddda0c0ad
name: Good Morning
type: SCENE
is_active: true
devices:
- dsn: TESTDSN_787294_001
product_name: TESTDEVICE_001
oem_model: ledevb
lan_enabled: false
connected_at: '2020-07-06T11:08:03Z'
connection_status: Offline
states:
- property_name: integer_output_tp1
base_type: integer
property_value: '1008'
- property_name: string_input_tp1
base_type: string
property_value: '1008'
- dsn: TESTDSN_763168_004
product_name: TESTDEVICE_004
oem_model: ledevb-test
lan_enabled: false
connected_at: '2020-02-08T05:33:08Z'
connection_status: Offline
states:
- property_name: integer_output_tp1
base_type: integer
property_value: '1008'
- property_name: string_input_tp1
base_type: string
property_value: OK
child_collections:
- collection_uuid: a8ae010c-2dde-4140-8e19-116363eaa475
name: Room102
states:
- property_name: integer_output_tp1
base_type: integer
property_value: '1008'
- property_name: string_input_tp1
base_type: string
property_value: OK
custom_attributes:
color: '#F08080'
sort_order: ascending
schedule:
end_date: '2021-12-02'
days_of_week:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
months_of_year:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
end_time_each_day: 00:00:00
start_time_each_day: 00:00:00
name: sched-2021-09-15-21:40:08
days_of_month: '[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, ...]'
active: true
start_date: '2021-10-02'
metadata:
sunrise_sunset: true
time_zone: America/Los_Angeles
utc: false
total: 1
previous_page: null
next_page: null
current_page_number: 1
start_count_on_page: 1
end_count_on_page: 1
schema:
type: object
properties:
collections:
type: array
items:
type: object
properties:
collection_uuid:
type: string
example: 8ae79d4b-bc40-4bc3-889e-7cbddda0c0ad
name:
type: string
example: Good Morning
type:
type: string
example: SCENE
is_active:
type: boolean
example: true
default: true
devices:
type: array
items:
type: object
properties:
dsn:
type: string
example: TESTDSN_787294_001
product_name:
type: string
example: TESTDEVICE_001
oem_model:
type: string
example: ledevb
lan_enabled:
type: boolean
example: false
default: true
connected_at:
type: string
example: '2020-07-06T11:08:03Z'
connection_status:
type: string
example: Offline
states:
type: array
items:
type: object
properties:
property_name:
type: string
example: integer_output_tp1
base_type:
type: string
example: integer
property_value:
type: string
example: '1008'
child_collections:
type: array
items:
type: object
properties:
collection_uuid:
type: string
example: a8ae010c-2dde-4140-8e19-116363eaa475
name:
type: string
example: Room102
states:
type: array
items:
type: object
properties:
property_name:
type: string
example: integer_output_tp1
base_type:
type: string
example: integer
property_value:
type: string
example: '1008'
custom_attributes:
type: object
properties:
color:
type: string
example: '#F08080'
sort_order:
type: string
example: ascending
schedule:
type: object
properties:
end_date:
type: string
example: '2021-12-02'
days_of_week:
type: array
items:
type: integer
example: 1
default: 0
months_of_year:
type: array
items:
type: integer
example: 1
default: 0
end_time_each_day:
type: string
example: 00:00:00
start_time_each_day:
type: string
example: 00:00:00
name:
type: string
example: sched-2021-09-15-21:40:08
days_of_month:
type: string
example: '[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, ...]'
active:
type: boolean
example: true
default: true
start_date:
type: string
example: '2021-10-02'
metadata:
type: object
properties:
sunrise_sunset:
type: boolean
example: true
default: true
time_zone:
type: string
example: America/Los_Angeles
utc:
type: boolean
example: false
default: true
total:
type: integer
example: 1
default: 0
previous_page:
type: integer
next_page:
type: integer
current_page_number:
type: integer
example: 1
default: 0
start_count_on_page:
type: integer
example: 1
default: 0
end_count_on_page:
type: integer
example: 1
default: 0
'400':
content: {}
description: Bad Request
'401':
content: {}
description: Unauthorized
'403':
content: {}
description: Forbidden
deprecated: false
tags:
- Collections.json
post:
summary: Create group or scene (DEPRECATED)
description: 'This API is used to create a group or scene.
Use the parameter "type" to specify whether you want to create a group or scene.
("type": "GROUP" or "type": "SCENE").
**NOTE**: This API is deprecated. Please refer to collections_2 endpoint.'
operationId: create-group-or-scene-deprecated
requestBody:
content:
application/json:
schema:
type: object
properties:
RAW_BODY:
type: string
format: json
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: ''
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'401':
description: '401'
content:
text/plain:
examples:
Result:
value: ''
'403':
description: '403'
content:
text/plain:
examples:
Result:
value: ''
'422':
description: '422'
content:
text/plain:
examples:
Result:
value: ''
deprecated: true
tags:
- Collections.json
delete:
summary: Delete all collections
description: This API is used to delete all the collections of a specified type.
operationId: delete-all-collections
parameters:
- name: collection_type
in: query
description: GROUP or SCENE (case insensitive).
schema:
type: string
responses:
'204':
content: {}
description: No Content
'401':
content: {}
description: Unauthorized
'403':
content: {}
description: Forbidden
'404':
content: {}
description: Not Found
tags:
- Collections.json
components:
securitySchemes:
sec0:
type: apiKey
in: header
name: Authorization
x-default: auth_token
x-readme-fauxas: true
x-provenance:
method: searched
source: https://docs.aylanetworks.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.aylanetworks.com/reference/activate-scene-based-on-countdown-timer.md
- https://docs.aylanetworks.com/reference/activate-scene-based-on-schedule.md
- https://docs.aylanetworks.com/reference/activate-scene-based-on-schedule_2.md
- https://docs.aylanetworks.com/reference/activate-scene-manually-tap-to-run.md
- https://docs.aylanetworks.com/reference/add-attributes-to-collection.md
- https://docs.aylanetworks.com/reference/add-devices-or-child-collections.md
- https://docs.aylanetworks.com/reference/create-group-1.md
- https://docs.aylanetworks.com/reference/create-group-or-scene-deprecated.md
- https://docs.aylanetworks.com/reference/delete-all-collections.md
- https://docs.aylanetworks.com/reference/delete-collection.md
- https://docs.aylanetworks.com/reference/delete-multiple-collections.md
- https://docs.aylanetworks.com/reference/delete-schedule.md
- https://docs.aylanetworks.com/reference/enable-disable-scene-automation.md
- https://docs.aylanetworks.com/reference/get-collections-by-dsn-and-type.md
- https://docs.aylanetworks.com/reference/get-last-posted-datapoints-for-a-collection.md
- https://docs.aylanetworks.com/reference/get-received-shares-1.md
- https://docs.aylanetworks.com/reference/get-shared-collections-owned-by-user.md
- https://docs.aylanetworks.com/reference/post-datapoints-to-collection.md
- https://docs.aylanetworks.com/reference/remove-custom-attributes.md
- https://docs.aylanetworks.com/reference/remove-devices.md
- https://docs.aylanetworks.com/reference/remove-specific-devices-or-child-collections.md
- https://docs.aylanetworks.com/reference/retrieve-collection-1.md
- https://docs.aylanetworks.com/reference/retrieve-collection-2.md
- https://docs.aylanetworks.com/reference/retrieve-collections.md
- https://docs.aylanetworks.com/reference/share-group-or-scene.md
- https://docs.aylanetworks.com/reference/stop-sharing-collection.md
- https://docs.aylanetworks.com/reference/update-collection-name-1.md
- https://docs.aylanetworks.com/reference/update-collection-name.md
- https://docs.aylanetworks.com/reference/update-custom-attributes.md
- https://docs.aylanetworks.com/reference/update-schedule.md
- https://docs.aylanetworks.com/reference/update-schedule_2.md
- https://docs.aylanetworks.com/reference/update-share-1.md
merge:
pages: 32
deduped: 31
conflicts_kept_first: 0