Helix Resources

Resource	Endpoint	Description
User	Get Users	Get list of Users @index
User	Get Users	Get list of Users with social connections @index2
User	Get Users	Get list of Users

User

Get Users

GEThttps://api.example.org/helix/users

Get list of Users @index

Request Query Parameters

Field	Type	Required	Description
my_query_parameter	Date	No	Example Description

Response Body

Field	Type	Description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description

Example response

{
    "id": 42,
    "username": "derpierre65",
    "email": "hello@derpierre65.dev",
    "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
    "created_at": "2022-01-01T00:00:00Z"
}

Get Users

GEThttps://api.example.org/helix/users

Get list of Users with social connections @index2

Response Body

Field	Type	Description
data	Array[]	No description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description

Example response

{
    "data": [
        {
            "id": 42,
            "username": "derpierre65",
            "email": "hello@derpierre65.dev",
            "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
            "created_at": "2022-01-01T00:00:00Z"
        }
    ]
}

Get Users

GEThttps://api.example.org/helix/users

Get list of Users

Example response

[]