GET https://restapi.actonsoftware.com/ucl/v2/segment/contacts/{accountId}/list/{segmentId}
This endpoint allows you to add an individual contact to a list in Act-On
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| authorization | header | false | required | string | Insert your generated access token. (Bearer {access token}) |
| accountId | Path | false | required | number | Account ID where query needs to be done |
| segmentId | Path | False | required | String | Specify the list ID in which you would like to access. |
| pageSize | query | false | optional | number (maximum=1000) | Specify the number of elements to fetch. (Default=100) (Maximum=1000) |
| pageNumber | query | false | optional | number | Specify the element offset to begin the fetch. (Default=0) |
| Search | query | false | optional | String | Specify word to filter records from segment |
| columns | Query | False | Optional | String |
Using a semicolon as the delimiter specify the fields (URLEncoded Required) you would like returned. |
| responseFormat | Query | False | Optional |
Specify the response format. It can be CSV or JSON. (Default=JSON) |
Response
{
"id": "q-0181",
"pageNumber": 0,
"pageSize": 0,
"search": "",
"headers": [
"ObjectType",
"Act-On Primary Score",
"First Name",
"Last Name",
"Company",
"Department",
"Email",
"Title",
"Mailing Street",
"Mailing City",
"Mailing State/Province",
"Mailing Zip/Postal Code",
"Mailing Country",
"Other Street",
"Other City",
"Other Zip/Postal Code",
"Other Country",
"Business Phone",
"Business Fax",
"Other Phone",
"Mobile Phone",
"Website",
"Other State/Province",
"Created Date",
"Modified Date"
],
"totalCount": 21,
"rowIds": {
"l-unified-contacts:31a": 794,
"l-unified-contacts:44f": 1103,
"l-unified-contacts:55f": 1375,
"l-unified-contacts:44e": 1102,
"l-unified-contacts:319": 793,
"l-unified-contacts:4f0": 1264,
"l-unified-contacts:4f2": 1266,
"l-unified-contacts:4f1": 1265,
"l-unified-contacts:4f3": 1267,
"l-unified-contacts:4dd": 1245,
"l-unified-contacts:4dc": 1244,
"l-unified-contacts:316": 790,
"l-unified-contacts:503": 1283,
"l-unified-contacts:318": 792,
"l-unified-contacts:317": 791,
"l-unified-contacts:504": 1284,
"l-unified-contacts:396": 918,
"l-unified-contacts:451": 1105,
"l-unified-contacts:561": 1377,
"l-unified-contacts:450": 1104,
"l-unified-contacts:560": 1376
},
"hasNextPage": null
}
Code Examples
cURL
curl -X GET https://restapi.actonsoftware.com/ucl/v2/segment/contacts/{accountId}/list/{segmentId} -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"
