Lists API

Lists API is used to manage lists under an Agenty account. You may use this API to create list, get all lists, add new rows, update rows or delete rows from a list etc.

Create a List

Endpoint:

Method: POST
URL: https://api.agenty.com/v1/lists

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}}

Body:

{
    "name": "URLs list for fashion category",
    "description": "List of products URL"
}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "A new list with id: 70 created successfully",
    "list_id": 70
}

Get List by id

Endpoint:

Method: GET
URL: https://api.agenty.com/v1/lists/{{LIST_ID}}

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}} Your api key

Responses:

Status: OK | Code: 200

{
    "list_id": 70,
    "name": "URLs list for fashion category",
    "description": "List of products URL",
    "total_rows": 0,
    "created_at": "2019-03-08T13:07:23",
    "updated_at": null
}

Update a List by id

Endpoint:

Method: PUT
URL: https://api.agenty.com/v1/lists/{{LIST_ID}}

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}}

Body:

{
    "list_id": 70,
    "name": "URLs list updated on april 2019",
    "description": "List of 50000 products URL"
}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "List with id: 70 updated successfully"
}

Get all Lists

Endpoint:

Method: GET
URL: https://api.agenty.com/v1/lists

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}}

Responses:

Status: OK | Code: 200

{
    "total": 3,
    "limit": 1000,
    "offset": 0,
    "returned": 3,
    "result": [
        {
            "list_id": 70,
            "name": "URLs list updated on april 2019",
            "description": "List of 50000 products URL",
            "total_rows": 0,
            "created_at": "2019-03-08T13:05:14",
            "updated_at": "2019-03-08T13:08:26"
        },
        {
            "list_id": 71,
            "name": "URL list for mobile category",
            "description": null,
            "total_rows": 0,
            "created_at": "2019-03-08T13:05:53",
            "updated_at": null
        },
		......
    ]
}

Delete List by id

Endpoint:

Method: DELETE
URL: https://api.agenty.com/v1/lists/{{LIST_ID}}

Query params:

Key Value Description
apikey {{API_KEY}}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "List with id : 70 deleted successfully"
}