GET
/
api
/
campaigns
/
{campaignId}
Get campaign by ID
curl --request GET \
  --url https://api.atendai.com/api/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "groupMembersLimit": 123,
  "releaseDate": "2023-11-07T05:31:56Z",
  "acceptEntriesUntil": "2023-11-07T05:31:56Z",
  "isActive": true,
  "companyId": "<string>",
  "whatsappId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "groups": [
    {
      "id": "<string>",
      "jid": "<string>",
      "name": "<string>",
      "description": "<string>",
      "picture": "<string>",
      "inviteLink": "<string>",
      "membersCount": 123,
      "initialMembers": {},
      "settings": {},
      "logs": {},
      "order": 123,
      "campaignId": "<string>",
      "companyId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaignId
string
required

The ID of the campaign to retrieve

Response

200
application/json

Successful response

The response is of type object.