Skip to main content
Server path: /customerio-customers | Type: Application | PCID required: Yes

Tools

ToolDescription
customerio_customers_create_man_segmentCreate a manual segment
customerio_customers_delete_man_segmentDelete a segment
customerio_customers_get_channelsList subscription channels
customerio_customers_get_object_attributesGet Object Attributes
customerio_customers_get_object_relationshipsGet Object Relationships
customerio_customers_get_object_typesList object types
customerio_customers_get_objects_filterFind objects
customerio_customers_get_people_by_idList customers, attributes, and devices
customerio_customers_get_people_emailGet customers by email
customerio_customers_get_people_filterSearch for customers
customerio_customers_get_person_activitiesLookup a customer’s activities
customerio_customers_get_person_attributesLookup a customer’s attributes
customerio_customers_get_person_messagesLookup messages sent to a customer
customerio_customers_get_person_relationshipsLookup a customer’s relationships
customerio_customers_get_person_segmentsLookup a customer’s segments
customerio_customers_get_person_subscription_preferencesLookup a customer’s subscription preferences
customerio_customers_get_segmentGet a segment
customerio_customers_get_segment_countGet a segment customer count
customerio_customers_get_segment_dependenciesGet a segment’s dependencies
customerio_customers_get_segment_membershipList customers in a segment
customerio_customers_get_subscription_center_tokenGenerate a subscription center token
customerio_customers_get_topicsList subscription topics
customerio_customers_list_segmentsList segments

customerio_customers_create_man_segment

Create a manual segment Parameters:
ParameterTypeRequiredDefaultDescription
segmentobjectYesThe segment value

customerio_customers_delete_man_segment

Delete a segment Parameters:
ParameterTypeRequiredDefaultDescription
segment_idintegerYesThe identifier for a segment. You can find your segment’s ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API.

customerio_customers_get_channels

List subscription channels

customerio_customers_get_object_attributes

Get Object Attributes Parameters:
ParameterTypeRequiredDefaultDescription
object_type_idintegerYesThe object type an object belongs to—like “Companies” or “Accounts”. Object type IDs begin at 1 and increment for each new type.
object_idstringYesThe object_id or cio_object_id of an object, depending on the id_type specified in query params. id_type defaults to object_id.
id_typestringNoId Type

customerio_customers_get_object_relationships

Get Object Relationships Parameters:
ParameterTypeRequiredDefaultDescription
object_type_idintegerYesThe object type an object belongs to—like “Companies” or “Accounts”. Object type IDs begin at 1 and increment for each new type.
object_idstringYesThe object_id or cio_object_id of an object, depending on the id_type specified in query params. id_type defaults to object_id.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
id_typestringNoId Type

customerio_customers_get_object_types

List object types

customerio_customers_get_objects_filter

Find objects Parameters:
ParameterTypeRequiredDefaultDescription
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
filterobjectYesWhen filtering for objects, you can use and and or arrays to determine the logic for a group of filter conditions. not reverses the filter condition and matches when the condition is false. object_attribute represents the individual conditions you can filter objects by. The top level of this object can only contain a single property, but you can nest and and or properties to produce complex filters.
object_type_idstringYesThe type of object you want to search in. Object type IDs are integers passed as strings.

customerio_customers_get_people_by_id

List customers, attributes, and devices Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesAn array of up to 100 customer IDs.

customerio_customers_get_people_email

Get customers by email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email address you want to search for.

customerio_customers_get_people_filter

Search for customers Parameters:
ParameterTypeRequiredDefaultDescription
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
filterobjectYesWhen filtering for people, you can use and and or arrays to determine the logic for a group of filter conditions. not reverses the filter condition and matches when the condition is false. segment and attribute represent the individual conditions you can filter a group of people for. The top level of this object can only contain a single property, but you can nest and and or properties to produce complex filters.

customerio_customers_get_person_activities

Lookup a customer’s activities Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
typestringNoThe type of activity you want to search for. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.
namestringNoFor event and attribute_update types, you can search by event or attribute name respectively.

customerio_customers_get_person_attributes

Lookup a customer’s attributes Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.

customerio_customers_get_person_messages

Lookup messages sent to a customer Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
start_tsintegerNoThe beginning timestamp for your query.
end_tsintegerNoThe ending timestamp for your query.

customerio_customers_get_person_relationships

Lookup a customer’s relationships Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.

customerio_customers_get_person_segments

Lookup a customer’s segments Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.

customerio_customers_get_person_subscription_preferences

Lookup a customer’s subscription preferences Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe ID of the customer you want to perform an operation against.
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.
languagestringNoA language tag you want the content translated in. If none is provided, the content will be sent in the default language of your subscription center.
Accept-LanguagestringNoThe language tag you want the content translated in. If none is provided, the content will be sent in the default lanauge of your subscription center.

customerio_customers_get_segment

Get a segment Parameters:
ParameterTypeRequiredDefaultDescription
segment_idintegerYesThe identifier for a segment. You can find your segment’s ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API.

customerio_customers_get_segment_count

Get a segment customer count Parameters:
ParameterTypeRequiredDefaultDescription
segment_idintegerYesThe identifier for a segment. You can find your segment’s ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API.

customerio_customers_get_segment_dependencies

Get a segment’s dependencies Parameters:
ParameterTypeRequiredDefaultDescription
segment_idintegerYesThe identifier for a segment. You can find your segment’s ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API.

customerio_customers_get_segment_membership

List customers in a segment Parameters:
ParameterTypeRequiredDefaultDescription
segment_idintegerYesThe identifier for a segment. You can find your segment’s ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.

customerio_customers_get_subscription_center_token

Generate a subscription center token Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesThe identifier for a person in your workspace—the same value you’d use as an id or email to identify a person in Customer.io.

customerio_customers_get_topics

List subscription topics

customerio_customers_list_segments

List segments