1. Campaign
  • Introdução
    • Comece Aqui
    • Autenticação
    • Recursos
  • API
    • Enterprise
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Profile
    • Company
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Order
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
    • Customer
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Validate phone
      • Blocked (batch)
      • Search individual
      • Search external
      • Track Record
      • Point
    • Withdrawal
      • Rescue
      • Reactivate
      • Show
      • Delete
      • Index
      • Search available
      • Quantity
      • Quantity Company (Monthly)
      • Quantity (Last Days)
    • Activation
      • Create
      • Update
      • Show
      • Delete
    • Promotion
      • Create
      • Update
      • Show
      • Delete
      • Index
    • Submission
      • Index
      • Show
      • Delete
    • Individual
      • Create
      • Index
      • Delete
    • Campaign
      • Create
        POST
      • Show
        GET
      • Update
        PUT
      • Delete
        DELETE
      • Index
        GET
    • Profile
      • Profile
      • Update profile
      • Update password profile
      • Inactivate
    • User
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Role
      • Create
      • Index
    • Permission
      • Create
      • Index
      • Delete
      • Show
      • Update
    • Status
      • Create
      • Index
      • Update
      • Delete
    • Tag
      • Create
      • Index
      • Update
      • Delete
    • Segment
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Pre Query Builder Segment
    • Product
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
      • Quantity
      • Quantity Sale Product Enterprise
      • Quantity Sale Product Enterprise (Monthly)
    • Webhooks
      • Overview
      • Create
      • Index
      • Delete
    • Billing
      • Quota
      • Index
      • Show
    • User Access Pin
      • Request
      • Revalidate
    • Target
      • Create
      • Delete
    • Redeem
      • Create
      • Index
    • Reward
      • Create
      • Index
      • Update
      • Delete
      • Show
      • Update active
    • Subscription
      • Index
      • Webhook Asaas
    • Payment Profile
      • Index
      • Update
  1. Campaign

Index

GET
/campaigns
Campaign
Endpoint Index (GET)
Esse Endpoint é responsável por listar todas as Campaigns ligadas ao seu Token

Requisição

Parâmetros Header

Respostas

🟢200OK
text/plain
Successful response
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/campaigns' \
--header 'Authorization: Bearer $TOKEN'
Response Response Example
[
  {
    "id": "b15fc8f0-204e-43cd-9a4d-c92caabd29d8",
    "name": "Api-teste",
    "description": "Api-teste",
    "relation_id": "5755ae2e-936c-4749-afd7-1be0e7469ece",
    "relation_code": "PROMOTION",
    "producer_in_progress": true,
    "start_date": "2025-11-25T18:31:51.000Z",
    "end_date": "2025-12-10T18:31:53.000Z",
    "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
    "segment_id": "f7827b85-fc15-4107-87b7-59d444190cde",
    "segment": {
      "id": "f7827b85-fc15-4107-87b7-59d444190cde",
      "name": "Valor total maior que 15",
      "description": "Valor total da compra maior que 15",
      "filter_quantity": 3,
      "filter_tree": "{\"id\":\"c8fb7777-0544-48a4-af46-a0c0ab3e8212\",\"type\":\"group\",\"children1\":{\"5a847ced-1765-4d1b-8873-c13895ee455f\":{\"type\":\"rule\",\"properties\":{\"field\":\"order.price\",\"operator\":\"greater_or_equal\",\"value\":[\"15\"],\"valueSrc\":[\"value\"],\"valueType\":[\"text\"]}}}}",
      "filter_sql": "order.price >= '15'",
      "filter_text": "order.price >= 15",
      "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
      "created_at": "2025-11-19T17:30:13.000Z"
    },
    "enterprise_strategy_id": "72e65b08-fdc7-475c-896e-7230f251c743",
    "enterpriseStrategy": {
      "id": "72e65b08-fdc7-475c-896e-7230f251c743",
      "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
      "strategy_id": "e21a6f3a-16e0-4f1e-8239-27f6812a56f1",
      "operation_mode": "ORDER"
    },
    "creator_user_id": "c3f99428-9b73-419f-80be-6803ec5eac5e",
    "creator": {
      "id": "c3f99428-9b73-419f-80be-6803ec5eac5e",
      "name": "api-teste",
      "username": "api-teste",
      "email": "api-teste@storycrm",
      "phone": "5585999999999",
      "active": true,
      "last_access": "2025-12-18T23:28:58.000Z",
      "inactivated_at": null,
      "created_at": "2025-10-06T18:22:01.000Z",
      "deleted_at": null
    },
    "tags": [
      {
        "id": "a4be5f5c-6af8-4fc2-bcac-1b507bc5d162",
        "name": "Api-teste",
        "description": "Api-teste",
        "enterprise_id": "54f083f9-640c-4025-b1a7-183f7b4de20c",
        "created_at": "2025-11-18T21:05:14.000Z"
      }
    ],
    "created_at": "2025-11-19T18:33:34.000Z"
  }
],

[
  {
    "id": "b15fc8f0-204e-43cd-9a4d-c92caabd29d8",
    "name": "Api-teste-update",
    "description": "Api-teste",
    "relation_id": "5755ae2e-936c-4749-afd7-1be0e7469ece",
    "relation_code": "PROMOTION",
    "producer_in_progress": true,
    "start_date": "2025-11-25T18:31:51.000Z",
    "end_date": "2025-12-10T18:31:53.000Z",
    "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
    "segment_id": "f7827b85-fc15-4107-87b7-59d444190cde",
    "segment": {
      "id": "f7827b85-fc15-4107-87b7-59d444190cde",
      "name": "Valor total maior que 15",
      "description": "Valor total da compra maior que 15",
      "filter_quantity": 3,
      "filter_tree": "{\"id\":\"c8fb7777-0544-48a4-af46-a0c0ab3e8212\",\"type\":\"group\",\"children1\":{\"5a847ced-1765-4d1b-8873-c13895ee455f\":{\"type\":\"rule\",\"properties\":{\"field\":\"order.price\",\"operator\":\"greater_or_equal\",\"value\":[\"15\"],\"valueSrc\":[\"value\"],\"valueType\":[\"text\"]}}}}",
      "filter_sql": "order.price >= '15'",
      "filter_text": "order.price >= 15",
      "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
      "created_at": "2025-11-19T17:30:13.000Z"
    },
    "enterprise_strategy_id": "72e65b08-fdc7-475c-896e-7230f251c743",
    "enterpriseStrategy": {
      "id": "72e65b08-fdc7-475c-896e-7230f251c743",
      "enterprise_id": "a840567c-807c-4ec6-9de6-595e04342ef8",
      "strategy_id": "e21a6f3a-16e0-4f1e-8239-27f6812a56f1",
      "operation_mode": "ORDER"
    },
    "creator_user_id": "c3f99428-9b73-419f-80be-6803ec5eac5e",
    "creator": {
      "id": "c3f99428-9b73-419f-80be-6803ec5eac5e",
      "name": "api-teste",
      "username": "api-teste",
      "email": "api-teste@storycrm",
      "phone": "5585999999999",
      "active": true,
      "last_access": "2025-12-18T23:28:58.000Z",
      "inactivated_at": null,
      "created_at": "2025-10-06T18:22:01.000Z",
      "deleted_at": null
    },
    "tags": [
      {
        "id": "a4be5f5c-6af8-4fc2-bcac-1b507bc5d162",
        "name": "Api-teste",
        "description": "Api-teste",
        "enterprise_id": "54f083f9-640c-4025-b1a7-183f7b4de20c",
        "created_at": "2025-11-18T21:05:14.000Z"
      }
    ],
    "created_at": "2025-11-19T18:33:34.000Z"
  }
]
Modificado em 2025-11-19 18:54:39
Página anterior
Delete
Próxima página
Profile
Built with