List Customer Lists

GET /customer-lists
Copied
Arrow
                https://api.ocamba.com/v1/hood/customer-lists

Returns a list of Customer Lists

query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ customer-list ]
An array of all created items.
Customer List
Name
Description
colorstring
Describes the customer list color. Must respect the hexcolof format. Default value is '#ffffff' or white.


Example: #6d9382
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2025-01-29 12:47:00
descriptionstring
The more detailed description of the customer list. Maximum 2000 characters


Example: List containing users that subscribed from the black friday mailing list.
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000105
namestring
Describes the customer list name. Must be unique per workspace. Maximum 100 characters.


Example: black friday list
update_timestring
Timezone: GMT.


Example: 2025-01-30 14:27:26
totalinteger
A total number of items.


Example: 5
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 Searchable field is: name.
2 Sortable fields are: name, description, color, create_time and update_time.
3 Filterable fields are: id, name, color, create_time, update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 500
{
  "total":5,
  "items":[
      {
        "id": "1000101",
        "company_id": "6197120",
        "name": "black friday list",
        "description": "List of all users who subscribed through the black firday newsletter.",
        "color": "#bba19f",
        "create_time": "2025-01-28 13:38:37",
        "update_time": "2025-01-28 13:38:37"
    },
    {
        "id": "1000109",
        "company_id": "6197120",
        "name": "Christmas sale list",
        "description": "List of all users who subscribed thourgh the christmas sale campaign.",
        "color": "#bdc19f",
        "create_time": "2025-01-29 12:38:23",
        "update_time": "2025-01-29 12:38:23"
    },
    {
        "id": "1000110",
        "company_id": "6197120",
        "name": "Returning buyers list",
        "description": "List of all users who were flagged as returning buyers.",
        "color": "#296a1d",
        "create_time": "2025-01-29 13:54:03",
        "update_time": "2025-02-03 13:54:53"
    }
  ]
}

{
  "total": 5,
  "items": [
    {
      "id": "1000105",
      "company_id": "7196310",
      "name": "black friday list",
      "color": "#6d9382",
      "description": "List containing users that subscribed from the black friday mailing list.",
      "create_time": "2025-01-29 12:47:00",
      "update_time": "2025-01-30 14:27:26"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}