> For the complete documentation index, see [llms.txt](https://create.cloud4wi.ai/dev-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://create.cloud4wi.ai/dev-hub/api-reference/getting-started/contacts.md).

# Contacts

**Contacts** represent the resource associated with mobile users or contacts acquired via Experiences.&#x20;

**Contact object: example**

{% hint style="info" %}
The Contact object may differ depending on the specific API. You can explore the Contact object in the definition of each API endpoint.
{% endhint %}

```json
{
      "cid":"string",
      "title":"string",
      "firstName":"string",
      "lastName":"string",
      "gender":"string",
      "birthDate":"string",
      "birthDay":"string",
      "age":"string",
      "country":"string",
      "zipCode":"string",
      "created":"string",
      "modified":"string",
      "email":"string",
      "emailVerified":true,
      "phone":"string",
      "phoneVerified":true,
      "signupMethod":"string",
      "externalIdentityId":"string",
      "username":"string",
      "locked":true,
      "organizationCid":"string",
      "locationCid":"string",
      "system":"string",
      "enabled":true,
      "type":"string",
      "locationName":"string",
      "personalId":"string",
      "externalSource":"string",
      "lastLogin":"string",
      "segmentCids":"string",
      "logins":0,
      "policies":[
        {
          "name":"string",
          "accepted":true
        }
      ],
      "segments":[
        {
          "cid":"string",
          "name":"string"
        }
      ],
      "extId":{
        "id":"string",
        "prop1":"string",
        "prop2":"string"
      },
      "metrics":{
        "frequencyMonthlyVisit":0,
        "compassTopLocation":"string",
        "compassTopLocationCount":0,
        "topFrequencyBuckets":"string",
        "lastVisitVenue":"string",
        "prefVisitWDay":"string",
        "lastVisitDateUtc":"string",
        "avgVisitLength":0,
        "countVisitedLocations":0,
        "prefVisitTimebucket":"string",
        "prefVisitTimeHour":"string",
        "lastVisitDateBusiness":"string",
        "countTotalVisits":0,
        "conversionRate":0,
        "avgDaysBetweenVisits":0
      }
    }
```

### Endpoints

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v2/customers/organizations/{cid}" method="get" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v2/customers/{cid}" method="get" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v2/customers/{cid}/events" method="get" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v2/customers/{cid}/devices" method="get" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v1/customers/{cid}/policies" method="put" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v1/customers/{cid}" method="delete" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

{% openapi src="<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>" path="/v2/customers/{cid}/accountings" method="get" %}
<https://developers.cloud4wi.com/api-explore-inspector/api-explore.yml>
{% endopenapi %}

### Data example

Example of Contact object returned by the endpoint <https://explore.cloud4wi.com//v2/customers/organizations/{cid}>

{% code overflow="wrap" %}

```json
{
   "generated":"2022-11-15T15:45:04Z",
   "totalCount":1,
   "count":1,
   "customers":[
      {
         "segments":[
            {
               "cid":"12d1f8713a1fecb953bcc64220813bc6",
               "name":"Loyal Customer"
            }
         ],
         "cid":"f4c6be2cebc56bf4b8a16a2d463d5b60",
         "title":null,
         "firstName":"Ivan",
         "lastName":"Muccini",
         "gender":"male",
         "birthDate":"1982",
         "birthDay":"01-29",
         "age":38,
         "country":"us",
         "zipCode":null,
         "created":"2022-07-21T17:58:35Z",
         "createdBusiness":"2022-07-21T17:58:35Z",
         "modified":"2022-11-15T05:19:43Z",
         "email":"imuccini3@cloud4wi.com",
         "emailVerified":false,
         "phone":"+14156264284",
         "phoneNumber":"4156264284",
         "phonePrefix":"+1",
         "phoneVerified":false,
         "signupMethod":"passthrough",
         "externalIdentityId":null,
         "username":"RG1DXHXHMRTW",
         "locked":false,
         "organizationCid":"155d60f21dc1938562900a0e201d54f6",
         "locationCid":"ff808081803ff92a01820195deb26263",
         "system":"mobileapp",
         "enabled":true,
         "type":"guest",
         "locationName":"hiddden_SECUREWIFI.IO",
         "personalId":null,
         "externalSource":"Cloud4wi",
         "policies":[
            {
               "name":"termsOfUse",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"privacy",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"mktgCommunications",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"profiling",
               "accepted":false,
               "date":"2020-10-26T14:18:21.000Z",
               "version":"1.00"
            }
         ],
         "lastLogin":"2022-08-02T14:48:57.000Z",
         "logins":182,
         "metrics":{
            "frequencyMonthlyVisit":3.0897396143865636,
            "compassTopLocation":"ff808081803ff92a01821d4cfd856805",
            "compassTopLocationCount":12,
            "topFrequencyBuckets":"daily",
            "lastVisitVenue":"ff808081803ff92a01821d4cfd856805",
            "prefVisitWDay":2,
            "lastVisitDateUtc":"2022-08-02T14:54:36Z",
            "avgVisitLength":461.3333333333333,
            "countVisitedLocations":1,
            "prefVisitTimebucket":"afternoon",
            "prefVisitTimeHour":"15",
            "lastVisitDateBusiness":"2022-08-02T07:54:36Z",
            "countTotalVisits":12,
            "conversionRate":1,
            "avgDaysBetweenVisits":1.0909090909090908
         },
         "emailValid":null,
         "language":"it",
         "splashLanguage":"it",
         "genericCustomField":[
            {
               "key":"loyalty_card",
               "value":"9500000012143687"
            }
         ],
         "extId":{
            
         }
      }
   ]
}
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://create.cloud4wi.ai/dev-hub/api-reference/getting-started/contacts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
