Query parameters
-
offset integer
Specify the ranking number of the first item on the page. Used for pagination.
-
limit integer
Specify how many results to return. Default is 50 campaigns, maximum is 100 campaigns.
Maximum value is
100
. Default value is50
. -
showArchives boolean
Specify if the archived campaigns should be included or not. Default is false.
Default value is
false
.
Responses
-
• 200
List of campaigns.
-
• 400
Bad Request -- Your request is invalid.
-
• 401
Unauthorized -- Your API key is wrong.
-
• 403
Forbidden -- The object requested is hidden for administrators only.
-
• 404
Not Found -- The specified object could not be found.
-
• 429
Too Many Requests -- You're requesting too many objects! Slow down!
-
• 500
Internal Server Error -- We had a problem with our server. Try again later.
-
• 503
Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
curl \
-X GET https://api.usecollect.com/v1/campaigns \
--user "username:password"
[
{
"_id": "mYCsdgB4DQoENBaX6",
"name": "ERC application",
"createdAt": "2022-11-22 13:28:08 UTC",
"status": "open",
"count": {
"request": 72,
"open": 4,
"done": 61,
"due": 5,
"waiting": 2,
"error": 0,
"message": 0
}
},
{
"_id": "wFndw23xmx5RdWrFX",
"name": "Company KYC",
"createdAt": "2023-01-31 09:49:25 UTC",
"status": "open",
"count": {
"request": 22,
"open": 4,
"done": 18,
"due": 0,
"waiting": 0,
"error": 0,
"message": 0
}
}
]