List Campaigns

Returns the list of active campaigns for the authenticated workspace with pagination options.

GET https://api.platica.mx/v1/campaigns

Query parameters

ParameterTypeDescriptionRequired
limitnumberMaximum number of campaigns in the response per workspace. Maximum: 500. Default: 50
pageTokenstringnextPageToken cursor from the previous response. Preferred over offset. Cannot be combined with offset, and is invalidated if you change the sort
offsetnumberNumber of records to skip. Legacy alternative to pageToken; capped at 100000
sortByenumSort field: lastUpdate (default) or creationDate
sortDirectionenumSort direction: desc (default) or asc

Response

{
  "workspaces": [
    {
      "id": "ws_abc123",
      "name": "Empresa Principal",
      "campaignsCount": 2,
      "campaigns": [
        {
          "id": "EgIOvaKPmrQFfuh6D023",
          "title": "solicitud_rfc_facturacion",
          "category": "utility",
          "platform": "whatsapp",
          "templateName": "solicitud_rfc_facturacion",
          "owners": [
            "soporte@empresa.com"
          ],
          "language": "es_MX",
          "creationDate": "2026-02-11T18:55:52.061Z",
          "lastUpdate": "2026-02-11T19:46:29.285Z"
        },
        {
          "id": "FhJPrbLQnsRGgvi7E134",
          "title": "Promo Verano",
          "category": "marketing",
          "platform": "whatsapp",
          "templateName": "promo_verano_2026",
          "owners": [],
          "creationDate": "2026-02-14T10:00:00.000Z",
          "lastUpdate": "2026-02-14T12:00:00.000Z"
        }
      ],
      "pagination": {
        "limit": 50,
        "offset": 0,
        "hasMore": false
      }
    }
  ],
  "nextPageToken": null
}

Response fields

FieldDescription
workspacesList of workspaces with their campaigns
nextPageTokenCursor to request the next page; null when no results are left. A single token covers every workspace the key can read, which is why it sits at the root instead of inside each one

Each item in workspaces[]

FieldDescription
idWorkspace ID
nameWorkspace name
campaignsList of campaign objects

Each item in campaigns[]

FieldDescription
idInternal campaign ID
titleCampaign title
categoryCategory: marketing or utility
platformSend platform
templateNameName of the associated template when one exists
ownersList of responsible-user emails
languageTemplate language when applicable (can be omitted)
creationDateCreation date in ISO 8601 format
lastUpdateLast update date in ISO 8601 format

Pagination fields

FieldDescription
campaignsCountTotal number of campaigns returned for that workspace
pagination.limitMaximum number of results requested
pagination.offsetNumber of results skipped
pagination.hasMoreIndicates whether more results exist