binders
List the content of a binder
/api/v1/binders/{binder_id}/children
The binder, then the binders and flows it holds that the account may see. A reader does not see what is offline.
key
Required scope: read
Path parameters
-
binder_idinteger · requiredId of the binder.
Response
200
BinderChildren
-
bindersarray of BinderThe binders.
13 fields
-
idintegerId, unique among the objects of its type.
-
typestringAlways
binder. -
namestringIts name.
-
rolestring or nullRole of the account on it:
owner,editororreader;nullwhen it holds none of its own. -
online_statusstringonline: open to its readers.offline: closed.pending_online/pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online. -
parent_idinteger or nullId of the binder that holds it;
nullat the root of a space. -
organisation_idinteger or nullId of the organisation whose space it lives in;
nullin a personal space. -
ownerOwnerThe account that owns it.
2 fields
-
idintegerId of the account.
-
namestringIts name, or its address when it has none.
-
-
created_atdate-timeWhen it was created.
-
updated_atdate-timeWhen it was last changed.
-
descriptionstringFree text; may be empty.
-
flows_countinteger or nullNumber of flows directly inside. Given in listings,
nullelsewhere. -
sub_binders_countinteger or nullNumber of binders directly inside. Given in listings,
nullelsewhere.
-
-
flowsarray of FlowThe flows.
13 fields
-
idintegerId, unique among the objects of its type.
-
typestringAlways
flow. -
namestringIts name.
-
rolestring or nullRole of the account on it:
owner,editororreader;nullwhen it holds none of its own. -
online_statusstringonline: open to its readers.offline: closed.pending_online/pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online. -
parent_idinteger or nullId of the binder that holds it;
nullat the root of a space. -
organisation_idinteger or nullId of the organisation whose space it lives in;
nullin a personal space. -
ownerOwnerThe account that owns it.
2 fields
-
idintegerId of the account.
-
namestringIts name, or its address when it has none.
-
-
created_atdate-timeWhen it was created.
-
updated_atdate-timeWhen it was last changed.
-
is_publishedbooleanWhether a published version exists.
-
published_atdate-time or nullWhen it was last published;
nullwhen it never was. -
has_unpublished_changesboolean or nullWhether the draft differs from the published version.
nullfor who may not edit the flow.
-
-
binderBinderThe binder itself.
13 fields
-
idintegerId, unique among the objects of its type.
-
typestringAlways
binder. -
namestringIts name.
-
rolestring or nullRole of the account on it:
owner,editororreader;nullwhen it holds none of its own. -
online_statusstringonline: open to its readers.offline: closed.pending_online/pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online. -
parent_idinteger or nullId of the binder that holds it;
nullat the root of a space. -
organisation_idinteger or nullId of the organisation whose space it lives in;
nullin a personal space. -
ownerOwnerThe account that owns it.
2 fields
-
idintegerId of the account.
-
namestringIts name, or its address when it has none.
-
-
created_atdate-timeWhen it was created.
-
updated_atdate-timeWhen it was last changed.
-
descriptionstringFree text; may be empty.
-
flows_countinteger or nullNumber of flows directly inside. Given in listings,
nullelsewhere. -
sub_binders_countinteger or nullNumber of binders directly inside. Given in listings,
nullelsewhere.
-
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
404
Nothing with that id, or nothing the account may open.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.