Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
D
docs
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Thomas
docs
Commits
622d80f7
Commit
622d80f7
authored
Oct 05, 2018
by
Eugen Rochko
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add lists API
parent
86eb63bc
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
122 additions
and
2 deletions
+122
-2
lists.md
content/en/api/rest/lists.md
+122
-2
No files found.
content/en/api/rest/lists.md
View file @
622d80f7
---
title
:
Lists
API
title
:
Lists
menu
:
docs
:
parent
:
api
parent
:
rest-
api
weight
:
10
---
## GET /api/v1/lists
User's lists.
Returns array of
[
List
](
{{
<
relref
"
entities
.
md
#
list
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read read:lists"
version=
"0.0.0"
>
}}
## GET /api/v1/accounts/:id/lists
User's lists that a given account is part of.
Returns array of
[
List
](
{{
<
relref
"
entities
.
md
#
list
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read read:lists"
version=
"0.0.0"
>
}}
## GET /api/v1/lists/:id/accounts
Accounts that are in a given list.
Returns array of
[
Account
](
{{
<
relref
"
entities
.
md
#
account
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read read:lists"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`limit`
| Maximum number of results | Optional | 40 |
### Pagination
>If you specify a `limit` of `0` in the query, all accounts will be returned without pagination. Otherwise, standard account pagination rules apply.
{{
<
api
_pagination
>
}}
## GET /api/v1/lists/:id
Returns
[
List
](
{{
<
relref
"
entities
.
md
#
list
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read read:lists"
version=
"0.0.0"
>
}}
## POST /api/v1/lists
Create a new list.
Returns
[
List
](
{{
<
relref
"
entities
.
md
#
list
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:lists"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`title`
| The title of the list | Required ||
## PUT /api/v1/lists/:id
Update a list.
Returns
[
List
](
{{
<
relref
"
entities
.
md
#
list
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:lists"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`title`
| The title of the list | Required ||
## DELETE /api/v1/lists/:id
Remove a list.
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:lists"
version=
"0.0.0"
>
}}
## POST /api/v1/lists/:id/accounts
Add accounts to a list.
> Only accounts already followed by the user can be added to a list.
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:lists"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`account_ids`
| Array of account IDs | Required ||
## DELETE /api/v1/lists/:id/accounts
Remove accounts from a list.
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:lists"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`account_ids`
| Array of account IDs | Required ||
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment