View Customer List

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

Retrieves the details of a Customer List that has previously been created if a valid identifier is provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
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

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: 1
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 If you don't know the customer list id, list the customer lists to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 500
{
    "total": 1,
    "items": [
        {
          "id": "1000100",
          "company_id": "6197120",
          "name": "black friday list",
          "description": "List of all users that subscribed through the black friday newsletter.",
          "color": "#ad019f",
          "create_time": "2025-01-28 13:13:24",
          "update_time": "2025-02-03 14:13:36"
      }
    ]
}

{
  "total": 1,
  "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."
}