Customers

Endpoints related to customer profiles in Okendo

Customers

Look up a Customer's ID by email address

post

Authorizations

basic

AuthorizationstringRequired

Body

application/json

emailstring · emailRequired

The email address of the Customer to look up.

Example: [email protected]

Responses

200

A Customer was found matching the provided email address.

application/json

customerIdstring · uuidOptional

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

post

/customer_lookup

HTTPcURLJavaScriptPython

POST /enterprise/customer_lookup HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "email": "[email protected]"
}

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieve basic details about a Customer

get

Authorizations

basic

AuthorizationstringRequired

Path parameters

customerIdstring · uuidRequired

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Responses

200

An object containing basic details about a Customer.

application/json

dateFirstActivestring · date-timeOptional

The date of the Customer's first action.

Example: 2022-01-18T02:21:20.380Z

dateLastActivestring · date-timeOptional

The date of the Customer's most recent action.

Example: 2023-02-14T04:34:21.390Z

emailstring · emailOptional

The email address of the customer.

Example: [email protected]

givenNamestringOptional

The given name of the customer. Often also known as the first name.

Example: Jane

familyNamestringOptional

The family name of the customer. Often also known as the last name.

Example: Smith

avatarUrlstring · uriOptional

The URL of the Customer's current avatar / profile picture.

Example: https://via.placeholder.com/160/1d2135/00eab6

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

get

/customers/{customerId}

HTTPcURLJavaScriptPython

GET /enterprise/customers/{customerId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "dateFirstActive": "2022-01-18T02:21:20.380Z",
  "dateLastActive": "2023-02-14T04:34:21.390Z",
  "email": "[email protected]",
  "givenName": "Jane",
  "familyName": "Smith",
  "avatarUrl": "https://via.placeholder.com/160/1d2135/00eab6",
  "location": {
    "country": "Australia",
    "zoneCode": "NSW"
  }
}

List Customer Profiles and their included properties

get

A Customer Profile is a collection of data points (grouped by namespace) about a specific Customer.

Authorizations

basic

AuthorizationstringRequired

Path parameters

customerIdstring · uuidRequired

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Query parameters

limitinteger · int32Optional

A limit on the number of items returned. Between 1 and 100. Default 25.

Example: 25

lastEvaluatedstringOptional

The URL-encoded JSON object representing the cursor for the next page of results.

namespacestringOptional

The identifier used to group Customer data. Specify this property to filter the Customer's profile data to a specific namespace.

Example: okendo-general

Responses

200

An object containing a list of Customer Profiles and a relative link to the next page of results if available.

application/json

nextUrlstring · uriOptional

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

get

/customers/{customerId}/profiles

HTTPcURLJavaScriptPython

GET /enterprise/customers/{customerId}/profiles HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "profiles": [
    {
      "namespace": "okendo-general",
      "properties": [
        {
          "name": "Given Name",
          "value": "Jane",
          "valueType": "string",
          "date": "2026-02-24T18:44:13.968Z"
        }
      ]
    }
  ],
  "nextUrl": "https://example.com"
}

List Customer Activities

get

A Customer Activity is an action that the Customer has taken or an action that relates to the Customer.

Authorizations

basic

AuthorizationstringRequired

Path parameters

customerIdstring · uuidRequired

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Query parameters

limitinteger · int32Optional

A limit on the number of items returned. Between 1 and 100. Default 25.

Example: 25

lastEvaluatedstringOptional

The URL-encoded JSON object representing the cursor for the next page of results.

namespacestringOptional

The identifier used to group Customer data. Specify this property to filter the Customer's activities to a specific namespace.

Example: okendo-general

Responses

200

An object containing a list of Customer Activities and a relative link to the next page of results if available.

application/json

nextUrlstring · uriOptional

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

get

/customers/{customerId}/activities

HTTPcURLJavaScriptPython

GET /enterprise/customers/{customerId}/activities HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "activities": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "okendo-general",
      "date": "2026-02-24T18:44:13.968Z",
      "title": "Review Submitted"
    }
  ],
  "nextUrl": "https://example.com"
}