OCoctaneai
profiles

List or find shopper profiles

get/v1/profiles

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Query parameters

qstring nullable
cursorstring nullable

From the previous page's nextCursor

limitinteger
quiz_idstring nullable
fromstring date nullable
tostring date nullable

Response

One page of shopper profiles. Contact data requires profiles:read and is never cached.

has_moreboolean required

Whether another page follows

next_cursorstring nullable required

Send as cursor for the next page; null on the last

totalinteger required

How many profiles match

returning_totalinteger nullable required

How many of total came back; null once the total is capped

total_cappedboolean

A search stops counting at 5,000: total is then that cap, read it as 5,000+

Example response

{
  "data": [
    {
      "id": "prof_7c9e6679742540de944be07fc1f90ae7",
      "quizzes": [
        {
          "id": "quiz_7c9e6679742540de944be07fc1f90ae7"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.