List all the requests of a campaign
This endpoint retrieves all the requests of a campaign.
Query parameters
-
campaignId string Required
Specify the ID of the campaign to retrieve.
-
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
. -
filter string
Filter requests by status. If not specify, will return all the requests except request cancelled, archived and the drafts.
Below you will find the data dictionary for the status attribute.Status Description pending The request has been sent and is not completed. completed The request has been sent, all the documents have been uploaded and the forms submitted. If validation is opted-in, the documents and data have been validated too. due The request has been sent, is not completed and is due. waiting The request has been sent, all the documents have been uploaded and the forms submitted but they have not been validated by the user. archived The request has been archived. cancelled The request has been cancelled. error An error happened when we sent the request. You can also use custom status here.
-
search string
String to look up. We will search into the contact first name, contact last name, contact email and all the custom data.
Responses
-
• 200 array[object]
List of requests of a 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/requests?campaignId=mYCsdgB4DQoENBaX6 \
--user "username:password"
[
{
"_id": "NxAHPWu9hRzcyD24m",
"campaignId": "mYCsdgB4DQoENBaX6",
"createdAt": "2022-05-22 13:40:26 UTC",
"portalUrl": "https://app.usecollect.com/portal/uGFRDeEL3Ct2uYo2c/NxAHPWu9hRzcyD24m",
"status": "due",
"dueDate": "2022-06-12 22:59:00 UTC",
"privacy": "team",
"contact": {
"_id": "uBJadNFcjrC6emRom",
"email": "elon@example.com",
"firstName": "Elon",
"lastName": "Musk",
"company": "Tesla",
"nbRequest": 11,
"tag": [],
"custom": [
{
"_id": "yw6XDyeFvbqr86yA6",
"name": "Favorite color",
"variable": "color",
"value": "Blue"
},
{
"_id": "CqdFwGX3yitk9zf8z",
"name": "Country",
"variable": "country",
"value": "US"
}
],
"createdAt": "2018-11-22 13:40:26 UTC",
"lastActivity": "2021-06-17 17:14:52 UTC"
},
"branding": {
"useBranding": true,
"brandingId": "jSEj7vHk3wLG3gRF7"
}
}
]