# Customers ## Customers ## POST /customer\_lookup > Look up a Customer's ID by email address ```json {"openapi":"3.0.1","info":{"title":"Okendo Enterprise API","version":"1.2.1"},"tags":[],"servers":[{"url":"https://api.okendo.io/enterprise"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"paths":{"/customer_lookup":{"post":{"tags":["customers"],"summary":"Look up a Customer's ID by email address","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"description":"The email address of the Customer to look up.","format":"email","type":"string"}},"required":["email"]}}},"required":true},"responses":{"200":{"description":"A Customer was found matching the provided email address.","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"format":"uuid","type":"string"}}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"description":{"type":"string"}}}}}}}},"401":{"description":"Authentication credentials are missing or incorrect."},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"description":{"type":"string"}}}}}}}}}}}}} ``` ## GET /customers/{customerId} > Retrieve basic details about a Customer ```json {"openapi":"3.0.1","info":{"title":"Okendo Enterprise API","version":"1.2.1"},"tags":[],"servers":[{"url":"https://api.okendo.io/enterprise"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"paths":{"/customers/{customerId}":{"get":{"tags":["customers"],"summary":"Retrieve basic details about a Customer","parameters":[{"name":"customerId","description":"The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"An object containing basic details about a Customer.","content":{"application/json":{"schema":{"type":"object","properties":{"dateFirstActive":{"description":"The date of the Customer's first action.","format":"date-time","type":"string"},"dateLastActive":{"description":"The date of the Customer's most recent action.","format":"date-time","type":"string"},"email":{"description":"The email address of the customer.","format":"email","type":"string"},"givenName":{"description":"The given name of the customer. Often also known as the first name.","type":"string"},"familyName":{"description":"The family name of the customer. Often also known as the last name.","type":"string"},"avatarUrl":{"description":"The URL of the Customer's current avatar / profile picture.","format":"uri","type":"string"},"location":{"type":"object","properties":{"country":{"description":"The name of the Customer's country."},"zoneCode":{"description":"The code identifying the Customer's state or province."}}}}}}}},"401":{"description":"Authentication credentials are missing or incorrect."},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"description":{"type":"string"}}}}}}}}}}}}} ``` ## List Customer Profiles and their included properties > A Customer Profile is a collection of data points (grouped by namespace) about a specific Customer. ```json {"openapi":"3.0.1","info":{"title":"Okendo Enterprise API","version":"1.2.1"},"tags":[],"servers":[{"url":"https://api.okendo.io/enterprise"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"paths":{"/customers/{customerId}/profiles":{"get":{"tags":["customers"],"summary":"List Customer Profiles and their included properties","description":"A Customer Profile is a collection of data points (grouped by namespace) about a specific Customer.","parameters":[{"description":"A limit on the number of items returned. Between 1 and 100. Default 25.","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"lastEvaluated","description":"The URL-encoded JSON object representing the cursor for the next page of results.","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","description":"The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"namespace","description":"The identifier used to group Customer data. Specify this property to filter the Customer's profile data to a specific namespace.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"An object containing a list of Customer Profiles and a relative link to the next page of results if available.","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"namespace":{"description":"An identifier used to group Customer data.","type":"string"},"properties":{"description":"The date of the customer's most recent action.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the property.","type":"string"},"value":{"description":"The value of the property.","type":"string"},"valueType":{"description":"The type of the property value. One of 'boolean', 'number', 'string', 'string-list', 'date', 'date-components', 'location' or 'image'.","type":"string"},"date":{"description":"The date that the property value was current.","type":"string","format":"date-time"}}}}}}},"nextUrl":{"type":"string","format":"uri"}}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"description":{"type":"string"}}}}}}}},"401":{"description":"Authentication credentials are missing or incorrect."}}}}}} ``` ## List Customer Activities > A Customer Activity is an action that the Customer has taken or an action that relates to the Customer. ```json {"openapi":"3.0.1","info":{"title":"Okendo Enterprise API","version":"1.2.1"},"tags":[],"servers":[{"url":"https://api.okendo.io/enterprise"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"paths":{"/customers/{customerId}/activities":{"get":{"tags":["customers"],"summary":"List Customer Activities","description":"A Customer Activity is an action that the Customer has taken or an action that relates to the Customer.","parameters":[{"description":"A limit on the number of items returned. Between 1 and 100. Default 25.","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"lastEvaluated","description":"The URL-encoded JSON object representing the cursor for the next page of results.","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","description":"The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"namespace","description":"The identifier used to group Customer data. Specify this property to filter the Customer's activities to a specific namespace.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"An object containing a list of Customer Activities and a relative link to the next page of results if available.","content":{"application/json":{"schema":{"type":"object","properties":{"activities":{"type":"array","items":{"type":"object","properties":{"activityId":{"description":"The ID of the Activity.","type":"string","format":"uuid"},"namespace":{"description":"An identifier used to group Customer data.","type":"string"},"date":{"description":"The date that the Activity occurred.","type":"string","format":"date-time"},"title":{"description":"The title of the Activity.","type":"string"}}}},"nextUrl":{"type":"string","format":"uri"}}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"description":{"type":"string"}}}}}}}},"401":{"description":"Authentication credentials are missing or incorrect."}}}}}} ``` --- # Agent Instructions: 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://docs.okendo.io/merchant-rest-api/endpoints/customers.md?ask= ``` 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.