Get All Courses

Description

 Get all courses in an account.

URL

https://portal.phishingbox.com/api/v1/Courses/all

Method

GET

URL Params

Required:

N/A

Optional:

limit=[integer]

Example: limit=100

Description: The record limit.

offset=[integer]

Example: offset=100

Description: The record offset.

POST Params

N/A

HTTP Headers

api-token: {api_token}

Success Response

Code: 200

{
    "response_code": 200,
    "success": true,
    "data": {
        "count": 350,
        "prev": "https://portal.phishingbox.com/api/v1/Courses/all?&offset=0&limit=100",
        "curr": "https://portal.phishingbox.com/api/v1/Courses/all?&offset=100&limit=100",
        "next": "https://portal.phishingbox.com/api/v1/Courses/all?&offset=200&limit=100",
        "last": "https://portal.phishingbox.com/api/v1/Courses/all?&offset=300&limit=100",
        "courses": [
            {
                "name": "Example Course 01",
                "id": "abcb1ce3-9177-4a70-bb31-62095e261095"
            },
            {
                "name": "Example Course 02",
                "id": "23da6c22-462a-4fd9-90d6-75c2ac8c5326"
            },
            {
                "name": "Example Course 03",
                "id": "9d79afe0-1456-425d-9b0e-213c4f65a2d2"
            },
            {
                "name": "Example Course 04",
                "id": "337b42cb-7b61-4384-9fd7-228f62d9f9d4"
            },
            "..."
        ]
    }
}

Error Response

Code: 401 Unauthorized

Content:

{
    "response_code":401,
    "success":false,
    "error_message":"Invalid API user token",
    "data":[]
}

Code: 403 Unauthorized

Content:

{
    "response_code":403,
    "success":false,
    "error_message":
    "API Accessed from Unauthorized Location",
    "data":[]
}

Notes

 Limit is capped at 100 records per call.

cURL Example

 curl --location --request POST 'https://portal.phishingbox.com/api/v1/Courses/all' \
--header 'api-token: 2c4763d7c10e1194c0070c7c17ab288823055edb' \