Get Contacts by Tag ID

GET

/api/Contact/ByTag/:tagId

GET

/api/Contact/ByTag/:tagId

curl -G https://api.virtuoussoftware.com/api/Contact/ByTag/tagId \
     -H "Authorization: Bearer <token>" \
     --data-urlencode filter=<string> \
     --data-urlencode sortBy=<string> \
     --data-urlencode descending=<boolean> \
     -d skip=1 \
     -d take=1

200Contacts and Individuals_getContactsByTagId_example

{
  "list": [
    {
      "id": "<integer>",
      "name": "<string>",
      "contactType": "<string>",
      "contactName": "<string>",
      "address": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "contactViewUrl": "<string>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "contactType": "<string>",
      "contactName": "<string>",
      "address": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "contactViewUrl": "<string>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tagIdstringRequired

Query parameters

filterstringOptional

The filter. If provided will filter by Id, Name or Email address.

sortBystringOptional

The field to be sorted. Supported: Id, Name, CreatedDateTime.

descendingstringOptional

The direction to be sorted.

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Response

listlist of objectsOptional

totalstringOptional