Queues

The following parameters might be required as part of the request URL:
Organization ID. Visible in Settings.
Queue ID. Found in the URL when inside a queue.
A queue is denoted as an object with the following fields:
active_users: A list with the names of the users currently assigned to at least one pending task in the queue.
created_at: The queue's creation timestamp.
id: The queue's identifier.
n_tasks: The number of pending tasks in the queue, waiting to be completed.
name: The queue title.
data: The queue's data configuration, which consists of a list of Block objects. This field is only included when explicitly fetching a queue by its identifier.
Here is an example of how a queue object looks like:
1
{
2
    "active_users": [
3
        "Bernat"
4
    ],
5
    "created_at": "2020-10-23T11:03:48.542064Z",
6
    "data": [
7
        {
8
            "id": "paragraph",
9
            "name": "Paragraph",
10
            "text": {
11
                "placeholder": "What is going on?"
12
            },
13
            "type": "text"
14
        },
15
        {
16
            "id": "categories",
17
            "name": "Categories",
18
            "single_selection": {
19
                "is_required": true,
20
                "options": [
21
                    {
22
                        "id": "red",
23
                        "name": "Red"
24
                    },
25
                    {
26
                        "id": "blue",
27
                        "name": "Blue"
28
                    },
29
                    {
30
                        "id": "green",
31
                        "name": "Green"
32
                    }
33
                ]
34
            },
35
            "type": "single_selection"
36
        },
37
        {
38
            "id": "picture",
39
            "image": {
40
                "placeholder": "https://i.imgur.com/3FlrkQd.jpg"
41
            },
42
            "name": "Picture",
43
            "type": "image"
44
        }
45
    ],
46
    "description": "",
47
    "id": 169,
48
    "n_tasks": 2,
49
    "name": "Categorization"
50
}
Copied!
get
https://api.humanlambdas.com
/orgs/$ORGANIZATION_ID/queues
List all queues
Sample request:
1
curl https://api.humanlambdas.com/orgs/$ORG_ID/queues \
2
-H "Authorization: Token $API_KEY"
Copied!
get
https://api.humanlambdas.com
/orgs/$ORGANIZATION_ID/queues/$QUEUE_ID
Get queue by ID
put
https://api.humanlambdas.com
/orgs/$ORGANIZATION_ID/queues/$QUEUE_ID/flush
Flush a queue

API - Previous

Introduction

Next - API

Tasks

Last modified 1yr ago

Copy link

Contents