Contact

A contact represents a person or organisation that interacts with the system. Contacts can have multiple associated addresses, payment methods, and activities. Contacts are used to track interactions, purchases, and other activities within the system.

List all contacts

get

Returns a list of contacts.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Query parameters

pageintegerOptional

The collection page number

Default: 1

dob[before]stringOptional

dob[strictly_before]stringOptional

dob[after]stringOptional

dob[strictly_after]stringOptional

createdAt[before]stringOptional

createdAt[strictly_before]stringOptional

createdAt[after]stringOptional

createdAt[strictly_after]stringOptional

updatedAt[before]stringOptional

updatedAt[strictly_before]stringOptional

updatedAt[after]stringOptional

updatedAt[strictly_after]stringOptional

lastInteractedAt[before]stringOptional

lastInteractedAt[strictly_before]stringOptional

lastInteractedAt[after]stringOptional

lastInteractedAt[strictly_after]stringOptional

emailAddress[]stringOptional

Responses

200

Contact collection

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

get

/contacts

HTTPcURLJavaScriptPython

GET /contacts HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "emailAddress": "[e-mail]",
    "dob": null,
    "phoneNumber": "",
    "organisation": "https://example.com/",
    "createdAt": "2025-11-21T23:21:53.080Z",
    "updatedAt": "2025-11-21T23:21:53.080Z",
    "firstName": "",
    "lastName": "",
    "name": "",
    "phoneNumberCountryCode": null,
    "timezone": "Europe/London",
    "totalSpend": 0,
    "tags": [
      {}
    ],
    "recency": null,
    "frequency": null,
    "monetary": null,
    "lastInteractedAt": "2025-11-21T23:21:53.080Z",
    "customFieldValues": [
      {
        "id": 1,
        "customFieldDefinition": "https://example.com/",
        "value": null,
        "createdAt": "2025-11-21T23:21:53.080Z",
        "updatedAt": "2025-11-21T23:21:53.080Z",
        "displayValue": null
      }
    ],
    "totalOrders": 0
  }
]

Retrieve a contact

get

Retrieves a Contact resource.

Authorizations

x_api_key

x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters

idstringRequired

Contact identifier

Responses

200

Contact resource

application/jsonapplication/ld+json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

/contacts/{id}

HTTPcURLJavaScriptPython

GET /contacts/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "emailAddress": "[e-mail]",
  "dob": null,
  "phoneNumber": "",
  "organisation": "https://example.com/",
  "createdAt": "2025-11-21T23:21:53.080Z",
  "updatedAt": "2025-11-21T23:21:53.080Z",
  "firstName": "",
  "lastName": "",
  "name": "",
  "phoneNumberCountryCode": null,
  "timezone": "Europe/London",
  "totalSpend": 0,
  "tags": [
    {}
  ],
  "recency": null,
  "frequency": null,
  "monetary": null,
  "lastInteractedAt": "2025-11-21T23:21:53.080Z",
  "customFieldValues": [
    {
      "id": 1,
      "customFieldDefinition": "https://example.com/",
      "value": null,
      "createdAt": "2025-11-21T23:21:53.080Z",
      "updatedAt": "2025-11-21T23:21:53.080Z",
      "displayValue": null
    }
  ],
  "totalOrders": 0
}