TAG LINE
SMALL TITLE

Contact Type Type

(API Version v4)


This entity represents types in the system that specify whether or not the Contact address should be used as the billing address, or the service address for taxation purposes.


What can you do with ContactTypeType?


Properties

Property Details
identity
READ-ONLY
"identity": 26
Type: Number
This is the unique numeric identifier for the ContactTypeType
name
READ-ONLY
"name": "Billing"
Type: String
System defined name for the Type of Contact


End Points

GETapi/v4/ContactType/Type/
Retrieve all of the ContactTypeType objects.
Retrieve all of the ContactTypeType objects.
GET api/v4/ContactType/Type/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Billing"
        }
    ]
}
GETapi/v4/ContactType/Type/Paged
Retrieve all of the ContactTypeType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the ContactTypeType objects in a paged fashion.
GET api/v4/ContactType/Type/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Billing"
            }
        ]
    }
}
GETapi/v4/ContactType/Type/{id}
Retrieve an instance of the ContactTypeType object by its ID.
{id}Unique identifier for the ContactTypeType object.
Retrieve an instance of the ContactTypeType object by its ID.
GET api/v4/ContactType/Type/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Billing"
    }
}
POSTapi/v4/ContactType/Type/Search
Retreive a list of ContactTypeType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of ContactTypeType objects based on search criteria.
POST api/v4/ContactType/Type/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Billing"
        }
    ]
}