Get Campaign List

cURL

curl --request GET \
  --url https://app.closerx.ai/api/v2/camp-quickcamp/ \
  --header 'Company-Name: <company-name>' \
  --header 'api_key: <api-key>'

{
  "total_count": 257,
  "total_page": 6,
  "Current_page_no": 1,
  "next_page_number": 2,
  "previous_page_number": null,
  "page_size": 50,
  "data": [
    {
      "id": "campdece6857",
      "name": "Rell (test)",
      "direction": "Outbound",
      "new_agent": "Financial",
      "contact_list": null,
      "knowledge_base": null,
      "calling_number": "+18446020950",
      "status": "paused",
      "total_bugget": 60,
      "bugget_left": "60.0000",
      "status_choices": [
        "active",
        "paused",
        "completed"
      ],
      "calling_number_pool": [
        "+17023600026",
        "+17023600027"
      ],
      "rotate_number_after_calls": 1,
      "release_buyed_when": "subscription_complete",
      "number_rotation": false,
      "created_at": "2025-08-23T10:54:50.133959Z",
      "updated_at": "2025-08-23T15:53:15.089678Z"
    }
  ]
}

GET

camp-quickcamp

cURL

curl --request GET \
  --url https://app.closerx.ai/api/v2/camp-quickcamp/ \
  --header 'Company-Name: <company-name>' \
  --header 'api_key: <api-key>'

{
  "total_count": 257,
  "total_page": 6,
  "Current_page_no": 1,
  "next_page_number": 2,
  "previous_page_number": null,
  "page_size": 50,
  "data": [
    {
      "id": "campdece6857",
      "name": "Rell (test)",
      "direction": "Outbound",
      "new_agent": "Financial",
      "contact_list": null,
      "knowledge_base": null,
      "calling_number": "+18446020950",
      "status": "paused",
      "total_bugget": 60,
      "bugget_left": "60.0000",
      "status_choices": [
        "active",
        "paused",
        "completed"
      ],
      "calling_number_pool": [
        "+17023600026",
        "+17023600027"
      ],
      "rotate_number_after_calls": 1,
      "release_buyed_when": "subscription_complete",
      "number_rotation": false,
      "created_at": "2025-08-23T10:54:50.133959Z",
      "updated_at": "2025-08-23T15:53:15.089678Z"
    }
  ]
}

Authorizations

api_key

string

header

required

Headers

Company-Name

string

required

The name of the schema to be used for the request

Query Parameters

string

The search term used to filter results

status

enum<string>

The status of the campaign (e.g., running, paused, completed)

Available options:

running,

paused,

completed

direction

enum<string>

The direction of the call (e.g., Outbound or Inbound)

Available options:

Outbound,

Inbound

sort_by

string

The field by which the results should be sorted (e.g., name, date)

page

integer

The page number to retrieve results from (for pagination)

Response

Get Quick Campaign data response

total_count

number

Total number of matching campaigns

Example:

257

total_page

number

Total number of pages

Example:

6

Current_page_no

number

Current page number

Example:

1

next_page_number

number | null

Next page number if available

Example:

2

previous_page_number

number | null

Previous page number if available

Example:

null

page_size

number

Number of items per page

Example:

50

data

object[]

List of campaign items

Show child attributes

data.id

string

Unique identifier for the campaign

Example:

"campdece6857"

data.name

string

Name of the campaign

Example:

"Rell (test)"

data.direction

string

Direction of the call campaign

Example:

"Outbound"

data.new_agent

string | null

Assigned agent name

Example:

"Financial"

data.contact_list

string | null

Reference to the contact list used in the campaign

Example:

null

data.knowledge_base

string | null

Knowledge base linked to the campaign

Example:

null

data.calling_number

string

Primary phone number used for the campaign

Example:

"+18446020950"

data.status

string

Current status of the campaign

Example:

"paused"

data.total_bugget

number

Total budget assigned to the campaign

Example:

60

data.bugget_left

string

Remaining budget as a string value

Example:

"60.0000"

data.status_choices

string[]

Possible status options for the campaign

Example:

["active", "paused", "completed"]

data.calling_number_pool

string[]

List of available calling numbers

Example:

["+17023600026", "+17023600027"]

data.rotate_number_after_calls

integer

Number of calls after which the number is rotated

Example:

1

data.release_buyed_when

string

Defines when to release purchased numbers

Example:

"subscription_complete"

data.number_rotation

boolean

Whether number rotation is enabled

Example:

false

data.created_at

string<date-time>

Creation timestamp

Example:

"2025-08-23T10:54:50.133959Z"

data.updated_at

string<date-time>

Last updated timestamp

Example:

"2025-08-23T15:53:15.089678Z"

Delete Agent Create Campaign

⌘I

API Documentation

Authentication

Dashboard Data

Agent

Campaign

Callbacks

Contact

Phone Number

Integrations

Billing & Subscription

Credits

Authorizations

Headers

Query Parameters

Response