--- title: "List automations" method: GET path: "/v1/campaigns" tags: ["Automations"] --- # List automations `GET /v1/campaigns` Returns a list of your automations and associated metadata. ## Response `200` Returns an array of automation objects. - object - `campaigns` CampaignObject[] — Each object is an automation in your workspace with one of seven types of automation triggers. - union - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'segment' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `trigger_segment_ids` integer[] — A list of segments used in the automation trigger, returned if the automation trigger included one or more segment conditions. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - `msg_templates` object[] — Indicates the message templates used in this automation. - `type` 'email' | 'sms' | 'push' | 'slack' — The message type the template represents. - `id` integer — The identifier for the template. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'event' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - `event_name` string — The name of the event. How you reference the event in automations or segments. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'form' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'date' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - `frequency` 'once' | 'monthly' | 'yearly' — How often a person will receive this automation based on the date specified in the automation trigger. - `date_attribute` string — The attribute on people's profiles you use to configure the date of the automation trigger. - `timezone` string — The time zone you set to configure the date of the automation trigger. - `use_customer_timezone` boolean — If you chose "the user's time zone" while configuring the date of the automation trigger, this is `true`. Otherwise, you set a specific time zone so it's `false`. - `start_hour` integer — The hour you set the automation to trigger. Follows the 24-hour clock. - `start_minutes` integer — The minutes you set the automation to trigger. Follows the 24-hour clock. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'relationship' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - `object_type_id` integer — The object type ID of the trigger. - `filter_object_attributes` string — A list of object attributes used in the automation filter, returned if the automation audience was filtered on one or more object attributes. - `filter_relationship_attributes` string — A list of relationship attributes used in the automation filter, returned if the automation audience was filtered on one or more relationship attributes. - `audience` object — Defines the people who will start a journey in your automation. - `type` integer — The selected audience type. `0` means person added to object; `1` can mean every or certain people in the object. Filters appear only for subset audiences. - `person_filters` object — Returns the profile attributes you filtered the audience by, if any. Only applies to `type 1`, "Certain people in the object". - `relationship_filters` object — Returns the relationship attributes you filtered the audience by, if any. Only applies to `type 1`, "Certain people in the object". - `relationship_attribute_triggers` object — A list of relationship attributes used to trigger the automation. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'object' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `filter_segment_ids` integer[] — A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments. - `object_type_id` integer — The object type ID of the trigger. - `filter_object_attributes` string — A list of object attributes used in the automation filter, returned if the automation audience was filtered on one or more object attributes. - `filter_relationship_attributes` string — A list of relationship attributes used in the automation filter, returned if the automation audience was filtered on one or more relationship attributes. - `audience` object — Defines the people who will start a journey in your automation. - `type` integer — The type of audience selected. "Every person in the object" is `1`. "Certain people in the object" is also `1`. "Certain people" will always have one or more audience filters (see below). "Every person" will never have an audience filter. - `person_filters` object — Returns the profile attributes you filtered the audience by, if any. Only applies to `type 1`, "Certain people in the object". - `relationship_filters` object — Returns the relationship attributes you filtered the audience by, if any. Only applies to `type 1`, "Certain people in the object". - `object_attribute_triggers` object — A list of object attributes used to trigger the automation. - object - `id` integer — The identifier for an automation. - `deduplicate_id` string — An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated. - `name` string — The name of the automation. - `description` string — The description of the automation, if one was set. - `type` 'webhook' — The type of automation trigger. **Sunsetting on March 30, 2025** - `created` integer — The date time when the referenced ID was created. - `updated` integer — The date time when the referenced ID was last updated. - `active` boolean — If true, the automation is active and can still send messages. - `state` 'running' | 'draft' | 'stopped' — The status of the automation. - `actions` object[] — An array of actions contained within the automation. - `type` string — The action type. - `id` integer — The identifier for the action. - `first_started` integer — The date and time when you first started the automation and it first became eligible to be triggered. - `tags` string[] — An array of tags you set on this automation. - `webhook_id` integer — The ID of the webhook trigger generated by Customer.io. ## Other responses - `429` — Your request is over the 10-per-second limit. --- [API](https://skmtc.dev/customer/apis/customer-io-journeys-api-reference.md) · [All operations](https://skmtc.dev/customer/apis/customer-io-journeys-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/customer/customer-io-journeys-api-reference/revisions/4b391af7cb06/schema)