Contacts

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. This API provides the following links in the `_links` object: * **`apiture:contacts`** -- links to the `contacts` collection * **`apiture:createContact`** -- links to a POST operation to create a new contact


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///contacts/"
import { APIApi } from "@apiture/contacts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Contacts.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///contacts/apiDoc"
import { APIApi } from "@apiture/contacts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Contacts.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


getLabels

Localized Labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`).


/labels

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///contacts/labels"
import { APIApi } from "@apiture/contacts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Contacts.APIApi.getLabels()
var opts = {
  'acceptLanguage': acceptLanguage_example // {String} The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getLabels(opts, callback);

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).

Responses


Contact

activateContact

Activate a contact.

Activate a contact from an inactive state. <p> This operation is invoked from the `apiture:activate` link on a contact resource when that contact is eligible to be activated. This operation is only allowed if the state is `inactive`. <p> This changes the `state` to `active`.


/activeContacts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///contacts/activeContacts?contact=&contactUri="
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.activateContact()
var contact = contact_example; // {String} A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
var opts = {
  'contactUri': contactUri_example, // {String} The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.activateContact(contact, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
contact*
String
A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
Required
contactUri
String
The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.


createContact

Create a new contact

Create a new contact in the contacts collection.


/contacts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///contacts/contacts"
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.createContact()
var createContact = ; // {CreateContact} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.createContact(createContact, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Body parameters
Name Description
createContact *

The data necessary to create a new contact.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deactivateContact

Deactivate a contact.

Deactivate a contact from an active state. <p> This operation is invoked from the `apiture:deactivate` link on a contact resource when that contact is eligible to be deactivated. This operation is only allowed if the state is `active`. <p> This changes the `state` to `inactive`.


/inactiveContacts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///contacts/inactiveContacts?contact=&contactUri="
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.deactivateContact()
var contact = contact_example; // {String} A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
var opts = {
  'contactUri': contactUri_example, // {String} The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.deactivateContact(contact, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
contact*
String
A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
Required
contactUri
String
The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.


getContact

Fetch a representation of this contact

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this contact resource.


/contacts/{contactId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///contacts/contacts/{contactId}"
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.getContact()
var contactId = contactId_example; // {String} The unique identifier of this contact. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.getContact(contactId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
contactId*
String
The unique identifier of this contact. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.


getContacts

Return a collection of contacts

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of contacts. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/contacts

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///contacts/contacts?start=&limit=&sortBy=&filter=&q=&state=&occupation="
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.getContacts()
var opts = {
  'start': 789, // {Long} The zero-based index of the first contact item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of contact representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the contacts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'occupation': occupation_example // {String} Subset the contacts collection to those with this name value. Use `|` to separate multiple values. For example, `?occupation=officeAndAdministrativeSupport` matches only items whose occupation is `officeAndAdministrativeSupport`; `?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving` matches items whose occupation is `officeAndAdministrativeSupport` or `transportationAndMaterialMoving`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering). The values are derived from the `occupation` label group from the result of the [`getLabels`](#op-getLabels) operation. 
**Note:** The enum list will be removed in future update to the API. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; contactApi.getContacts(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first contact item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of contact representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the contacts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
occupation
String
Subset the contacts collection to those with this name value. Use `|` to separate multiple values. For example, `?occupation=officeAndAdministrativeSupport` matches only items whose occupation is `officeAndAdministrativeSupport`; `?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving` matches items whose occupation is `officeAndAdministrativeSupport` or `transportationAndMaterialMoving`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering). The values are derived from the `occupation` label group from the result of the [`getLabels`](#op-getLabels) operation. <br> **Note:** The enum list will be removed in future update to the API.

Responses


patchContact

Update this contact

Perform a partial update of this contact. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/contacts/{contactId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///contacts/contacts/{contactId}"
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.patchContact()
var contactId = contactId_example; // {String} The unique identifier of this contact. This is an opaque string.
var contact = ; // {Contact} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.patchContact(contactId, contact, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
contactId*
String
The unique identifier of this contact. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
contact *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.


removeContact

Remove a contact.

Remove a contact by setting its state to `removed`. <p> This operation is invoked from the `apiture:remove` link on a contact resource when that contact is eligible to be removed. The contact must not be in use (there may not be any active associations to the contact). This operation is only allowed if the state is `inactive`. <p> This changes the `state` to `removed`.


/removedContacts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///contacts/removedContacts?contact=&contactUri="
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.removeContact()
var contact = contact_example; // {String} A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
var opts = {
  'contactUri': contactUri_example, // {String} The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.removeContact(contact, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
contact*
String
A string which identifies an existing contact to activate, deactivate, or remove by `POST`ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a `{contactId}` or a contact URI.
Required
contactUri
String
The URI of an existing contact which is eligible to be activated. This parameter is **deprecated**. Use the `?contact=` query parameter instead.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.


updateContact

Update this contact

Perform a complete replacement of this contact.


/contacts/{contactId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///contacts/contacts/{contactId}"
import { ContactApi } from "@apiture/contacts-client-sdk";

const contactApi = new ContactApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
contactApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
contactApi.setApiKey(apiKey);


var api = new Contacts.ContactApi.updateContact()
var contactId = contactId_example; // {String} The unique identifier of this contact. This is an opaque string.
var contact = ; // {Contact} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
contactApi.updateContact(contactId, contact, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
contactId*
String
The unique identifier of this contact. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
contact *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this contact resource.