Tomba

Bulks

Endpointhttps://api.tomba.io/v1

Get all search bulk operations

GET

https://api.tomba.io/v1

/bulk/search

Get all search bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all search bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all search bulk operations › Responses

List of bulk operations

object[]

object

GET/bulk/search

curl --request GET \
  --url https://api.tomba.io/v1/bulk/search \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new search bulk operation

POST

https://api.tomba.io/v1

/bulk/search

Create a new search bulk operation to find email addresses based on a list of domains.

You can provide the list of domains directly in the request body or upload a CSV file containing the domains.

Each domain should be on a new line in the CSV file.

The API will process the list and return a bulk operation ID that you can use to track the progress and retrieve the results once the operation is complete.

Create new search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new search bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

maximum

string · enum · required

Maximum results per domain

Enum values:

100

object · required

Type of emails to search for

object · required

Department filter

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new search bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/search

curl --request POST \
  --url https://api.tomba.io/v1/bulk/search \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "maximum": "1",
  "email_type": {
    "type": "all",
    "priority_type": "only"
  },
  "department": {
    "name": [
      "all"
    ],
    "priority_type": "only"
  }
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "maximum": "1",
  "email_type": {
    "type": "all",
    "priority_type": "only"
  },
  "department": {
    "name": [
      "all"
    ],
    "priority_type": "only"
  }
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific search bulk operation

GET

https://api.tomba.io/v1

/bulk/search/{id}

Get specific search bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific search bulk operation › Responses

Bulk operation details

object[]

GET/bulk/search/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/search/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch search bulk operation

PUT

https://api.tomba.io/v1

/bulk/search/{id}

Launch search bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch search bulk operation › Responses

Operation completed successfully

object

PUT/bulk/search/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/search/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete search bulk operation

DELETE

https://api.tomba.io/v1

/bulk/search/{id}/delete

Delete search bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete search bulk operation › Responses

Operation completed successfully

object

DELETE/bulk/search/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/search/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive search bulk operation

DELETE

https://api.tomba.io/v1

/bulk/search/{id}/archive

Archive search bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive search bulk operation › Responses

Operation completed successfully

object

DELETE/bulk/search/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/search/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get search bulk operation progress

GET

https://api.tomba.io/v1

/bulk/search/{id}/progress

Get search bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get search bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get search bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/search/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/search/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download search bulk results

GET

https://api.tomba.io/v1

/bulk/search/{id}/download

Download search bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download search bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download search bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download search bulk results › Responses

CSV file download

string

GET/bulk/search/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/search/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename search bulk operation

PUT

https://api.tomba.io/v1

/bulk/search/{id}/rename

Rename search bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename search bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename search bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename search bulk operation › Responses

Operation completed successfully

object

PUT/bulk/search/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/search/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all similar bulk operations

GET

https://api.tomba.io/v1

/bulk/similar

Get all similar bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all similar bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all similar bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/similar

curl --request GET \
  --url https://api.tomba.io/v1/bulk/similar \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new similar bulk operation

POST

https://api.tomba.io/v1

/bulk/similar

Create new similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new similar bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

maximum

string · enum · required

Maximum results per domain

Enum values:

100

object · required

Type of emails to search for

object · required

Department filter

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new similar bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/similar

curl --request POST \
  --url https://api.tomba.io/v1/bulk/similar \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "maximum": "1",
  "email_type": {
    "type": "all",
    "priority_type": "only"
  },
  "department": {
    "name": [
      "all"
    ],
    "priority_type": "only"
  }
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "maximum": "1",
  "email_type": {
    "type": "all",
    "priority_type": "only"
  },
  "department": {
    "name": [
      "all"
    ],
    "priority_type": "only"
  }
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific similar bulk operation

GET

https://api.tomba.io/v1

/bulk/similar/{id}

Get specific similar bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific similar bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/similar/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/similar/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch similar bulk operation

PUT

https://api.tomba.io/v1

/bulk/similar/{id}

Launch similar bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch similar bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/similar/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/similar/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete similar bulk operation

DELETE

https://api.tomba.io/v1

/bulk/similar/{id}/delete

Delete similar bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete similar bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/similar/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/similar/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive similar bulk operation

DELETE

https://api.tomba.io/v1

/bulk/similar/{id}/archive

Archive similar bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive similar bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/similar/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/similar/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get similar bulk operation progress

GET

https://api.tomba.io/v1

/bulk/similar/{id}/progress

Get similar bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get similar bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get similar bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/similar/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/similar/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download similar bulk results

GET

https://api.tomba.io/v1

/bulk/similar/{id}/download

Download similar bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download similar bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download similar bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download similar bulk results › Responses

200

CSV file download

string

GET/bulk/similar/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/similar/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename similar bulk operation

PUT

https://api.tomba.io/v1

/bulk/similar/{id}/rename

Rename similar bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename similar bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename similar bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename similar bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/similar/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/similar/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all company bulk operations

GET

https://api.tomba.io/v1

/bulk/company

Get all company bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all company bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all company bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/company

curl --request GET \
  --url https://api.tomba.io/v1/bulk/company \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new company bulk operation

POST

https://api.tomba.io/v1

/bulk/company

Create new company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new company bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new company bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/company

curl --request POST \
  --url https://api.tomba.io/v1/bulk/company \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific company bulk operation

GET

https://api.tomba.io/v1

/bulk/company/{id}

Get specific company bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific company bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/company/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/company/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch company bulk operation

PUT

https://api.tomba.io/v1

/bulk/company/{id}

Launch company bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch company bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/company/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/company/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete company bulk operation

DELETE

https://api.tomba.io/v1

/bulk/company/{id}/delete

Delete company bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete company bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/company/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/company/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive company bulk operation

DELETE

https://api.tomba.io/v1

/bulk/company/{id}/archive

Archive company bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive company bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/company/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/company/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get company bulk operation progress

GET

https://api.tomba.io/v1

/bulk/company/{id}/progress

Get company bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get company bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get company bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/company/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/company/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download company bulk results

GET

https://api.tomba.io/v1

/bulk/company/{id}/download

Download company bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download company bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download company bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download company bulk results › Responses

200

CSV file download

string

GET/bulk/company/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/company/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename company bulk operation

PUT

https://api.tomba.io/v1

/bulk/company/{id}/rename

Rename company bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename company bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename company bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename company bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/company/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/company/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all finder bulk operations

GET

https://api.tomba.io/v1

/bulk/finder

Get all finder bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all finder bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all finder bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/finder

curl --request GET \
  --url https://api.tomba.io/v1/bulk/finder \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new finder bulk operation

POST

https://api.tomba.io/v1

/bulk/finder

Create new finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new finder bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

file

string · required

CSV file for bulk processing

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

column_first

integer

First name column number

column_last

integer

Last name column number

column_name

integer

Full name column number

column_domain

integer

Domain column number (required)

skip

boolean

Skip first row (header)

Create new finder bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/finder

curl --request POST \
  --url https://api.tomba.io/v1/bulk/finder \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --form name=name \
  --form list=list \
  --form sources=true \
  --form notifie=true \
  --form verify=true \
  --form total=0 \
  --form delimiter=delimiter \
  --form valid=true \
  --form column=0 \
  --form column_first=0 \
  --form column_last=0 \
  --form column_name=0 \
  --form column_domain=0 \
  --form skip=true \
  --form file=file

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "column_first": 0,
  "column_last": 0,
  "column_name": 0,
  "column_domain": 0,
  "skip": true,
  "file": "file"
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific finder bulk operation

GET

https://api.tomba.io/v1

/bulk/finder/{id}

Get specific finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific finder bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/finder/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/finder/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch finder bulk operation

PUT

https://api.tomba.io/v1

/bulk/finder/{id}

Launch finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch finder bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/finder/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/finder/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete finder bulk operation

DELETE

https://api.tomba.io/v1

/bulk/finder/{id}/delete

Delete finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete finder bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/finder/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/finder/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive finder bulk operation

DELETE

https://api.tomba.io/v1

/bulk/finder/{id}/archive

Archive finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive finder bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/finder/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/finder/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get finder bulk operation progress

GET

https://api.tomba.io/v1

/bulk/finder/{id}/progress

Get finder bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get finder bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get finder bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/finder/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/finder/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download finder bulk results

GET

https://api.tomba.io/v1

/bulk/finder/{id}/download

Download finder bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download finder bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download finder bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download finder bulk results › Responses

200

CSV file download

string

GET/bulk/finder/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/finder/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename finder bulk operation

PUT

https://api.tomba.io/v1

/bulk/finder/{id}/rename

Rename finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename finder bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename finder bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/finder/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/finder/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all enrich bulk operations

GET

https://api.tomba.io/v1

/bulk/enrich

Get all enrich bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all enrich bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all enrich bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/enrich

curl --request GET \
  --url https://api.tomba.io/v1/bulk/enrich \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new enrich bulk operation

POST

https://api.tomba.io/v1

/bulk/enrich

Create new enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new enrich bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new enrich bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/enrich

curl --request POST \
  --url https://api.tomba.io/v1/bulk/enrich \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific enrich bulk operation

GET

https://api.tomba.io/v1

/bulk/enrich/{id}

Get specific enrich bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific enrich bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/enrich/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/enrich/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch enrich bulk operation

PUT

https://api.tomba.io/v1

/bulk/enrich/{id}

Launch enrich bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch enrich bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/enrich/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/enrich/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete enrich bulk operation

DELETE

https://api.tomba.io/v1

/bulk/enrich/{id}/delete

Delete enrich bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete enrich bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/enrich/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/enrich/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive enrich bulk operation

DELETE

https://api.tomba.io/v1

/bulk/enrich/{id}/archive

Archive enrich bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive enrich bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/enrich/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/enrich/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get enrich bulk operation progress

GET

https://api.tomba.io/v1

/bulk/enrich/{id}/progress

Get enrich bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get enrich bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get enrich bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/enrich/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/enrich/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download enrich bulk results

GET

https://api.tomba.io/v1

/bulk/enrich/{id}/download

Download enrich bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download enrich bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download enrich bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download enrich bulk results › Responses

200

CSV file download

string

GET/bulk/enrich/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/enrich/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename enrich bulk operation

PUT

https://api.tomba.io/v1

/bulk/enrich/{id}/rename

Rename enrich bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename enrich bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename enrich bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename enrich bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/enrich/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/enrich/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all LinkedIn bulk operations

GET

https://api.tomba.io/v1

/bulk/linkedin

Get all LinkedIn bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all LinkedIn bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all LinkedIn bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/linkedin

curl --request GET \
  --url https://api.tomba.io/v1/bulk/linkedin \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new LinkedIn bulk operation

POST

https://api.tomba.io/v1

/bulk/linkedin

Create new LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new LinkedIn bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new LinkedIn bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/linkedin

curl --request POST \
  --url https://api.tomba.io/v1/bulk/linkedin \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific LinkedIn bulk operation

GET

https://api.tomba.io/v1

/bulk/linkedin/{id}

Get specific LinkedIn bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific LinkedIn bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/linkedin/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/linkedin/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch LinkedIn bulk operation

PUT

https://api.tomba.io/v1

/bulk/linkedin/{id}

Launch LinkedIn bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch LinkedIn bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/linkedin/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/linkedin/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete LinkedIn bulk operation (alternative endpoint)

DELETE

https://api.tomba.io/v1

/bulk/linkedin/{id}

Delete LinkedIn bulk operation (alternative endpoint) › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete LinkedIn bulk operation (alternative endpoint) › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete LinkedIn bulk operation (alternative endpoint) › Responses

200

Operation completed successfully

object

DELETE/bulk/linkedin/{id}

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/linkedin/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete LinkedIn bulk operation

DELETE

https://api.tomba.io/v1

/bulk/linkedin/{id}/delete

Delete LinkedIn bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete LinkedIn bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/linkedin/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/linkedin/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive LinkedIn bulk operation

DELETE

https://api.tomba.io/v1

/bulk/linkedin/{id}/archive

Archive LinkedIn bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive LinkedIn bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/linkedin/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/linkedin/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get LinkedIn bulk operation progress

GET

https://api.tomba.io/v1

/bulk/linkedin/{id}/progress

Get LinkedIn bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get LinkedIn bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get LinkedIn bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/linkedin/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/linkedin/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download LinkedIn bulk results

GET

https://api.tomba.io/v1

/bulk/linkedin/{id}/download

Download LinkedIn bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download LinkedIn bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download LinkedIn bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download LinkedIn bulk results › Responses

200

CSV file download

string

GET/bulk/linkedin/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/linkedin/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename LinkedIn bulk operation

PUT

https://api.tomba.io/v1

/bulk/linkedin/{id}/rename

Rename LinkedIn bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename LinkedIn bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename LinkedIn bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename LinkedIn bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/linkedin/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/linkedin/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all author bulk operations

GET

https://api.tomba.io/v1

/bulk/author

Get all author bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all author bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all author bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/author

curl --request GET \
  --url https://api.tomba.io/v1/bulk/author \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new author bulk operation

POST

https://api.tomba.io/v1

/bulk/author

Create new author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new author bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new author bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/author

curl --request POST \
  --url https://api.tomba.io/v1/bulk/author \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific author bulk operation

GET

https://api.tomba.io/v1

/bulk/author/{id}

Get specific author bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific author bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/author/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/author/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch author bulk operation

PUT

https://api.tomba.io/v1

/bulk/author/{id}

Launch author bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch author bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/author/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/author/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete author bulk operation

DELETE

https://api.tomba.io/v1

/bulk/author/{id}/delete

Delete author bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete author bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/author/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/author/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive author bulk operation

DELETE

https://api.tomba.io/v1

/bulk/author/{id}/archive

Archive author bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive author bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/author/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/author/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get author bulk operation progress

GET

https://api.tomba.io/v1

/bulk/author/{id}/progress

Get author bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get author bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get author bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/author/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/author/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download author bulk results

GET

https://api.tomba.io/v1

/bulk/author/{id}/download

Download author bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download author bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download author bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download author bulk results › Responses

200

CSV file download

string

GET/bulk/author/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/author/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename author bulk operation

PUT

https://api.tomba.io/v1

/bulk/author/{id}/rename

Rename author bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename author bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename author bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename author bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/author/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/author/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all verifier bulk operations

GET

https://api.tomba.io/v1

/bulk/verifier

Get all verifier bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all verifier bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all verifier bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/verifier

curl --request GET \
  --url https://api.tomba.io/v1/bulk/verifier \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new verifier bulk operation

POST

https://api.tomba.io/v1

/bulk/verifier

Create new verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new verifier bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new verifier bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/verifier

curl --request POST \
  --url https://api.tomba.io/v1/bulk/verifier \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific verifier bulk operation

GET

https://api.tomba.io/v1

/bulk/verifier/{id}

Get specific verifier bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific verifier bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/verifier/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/verifier/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch verifier bulk operation

PUT

https://api.tomba.io/v1

/bulk/verifier/{id}

Launch verifier bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch verifier bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/verifier/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/verifier/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete verifier bulk operation

DELETE

https://api.tomba.io/v1

/bulk/verifier/{id}/delete

Delete verifier bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete verifier bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/verifier/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/verifier/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive verifier bulk operation

DELETE

https://api.tomba.io/v1

/bulk/verifier/{id}/archive

Archive verifier bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive verifier bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/verifier/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/verifier/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get verifier bulk operation progress

GET

https://api.tomba.io/v1

/bulk/verifier/{id}/progress

Get verifier bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get verifier bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get verifier bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/verifier/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/verifier/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download verifier bulk results

GET

https://api.tomba.io/v1

/bulk/verifier/{id}/download

Download verifier bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download verifier bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download verifier bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download verifier bulk results › Responses

200

CSV file download

string

GET/bulk/verifier/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/verifier/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename verifier bulk operation

PUT

https://api.tomba.io/v1

/bulk/verifier/{id}/rename

Rename verifier bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename verifier bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename verifier bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename verifier bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/verifier/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/verifier/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all phone finder bulk operations

GET

https://api.tomba.io/v1

/bulk/phone-finder

Get all phone finder bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all phone finder bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all phone finder bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/phone-finder

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-finder \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new phone finder bulk operation

POST

https://api.tomba.io/v1

/bulk/phone-finder

Create new phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new phone finder bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

Create new phone finder bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/phone-finder

curl --request POST \
  --url https://api.tomba.io/v1/bulk/phone-finder \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}
'

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific phone finder bulk operation

GET

https://api.tomba.io/v1

/bulk/phone-finder/{id}

Get specific phone finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific phone finder bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/phone-finder/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch phone finder bulk operation

PUT

https://api.tomba.io/v1

/bulk/phone-finder/{id}

Launch phone finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch phone finder bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/phone-finder/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete phone finder bulk operation

DELETE

https://api.tomba.io/v1

/bulk/phone-finder/{id}/delete

Delete phone finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete phone finder bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/phone-finder/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive phone finder bulk operation

DELETE

https://api.tomba.io/v1

/bulk/phone-finder/{id}/archive

Archive phone finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive phone finder bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/phone-finder/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get phone finder bulk operation progress

GET

https://api.tomba.io/v1

/bulk/phone-finder/{id}/progress

Get phone finder bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get phone finder bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get phone finder bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/phone-finder/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download phone finder bulk results

GET

https://api.tomba.io/v1

/bulk/phone-finder/{id}/download

Download phone finder bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download phone finder bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download phone finder bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download phone finder bulk results › Responses

200

CSV file download

string

GET/bulk/phone-finder/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-finder/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename phone finder bulk operation

PUT

https://api.tomba.io/v1

/phone-finder/{id}/rename

Rename phone finder bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename phone finder bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename phone finder bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename phone finder bulk operation › Responses

200

Operation completed successfully

object

PUT/phone-finder/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/phone-finder/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get all phone validator bulk operations

GET

https://api.tomba.io/v1

/bulk/phone-validator

Get all phone validator bulk operations › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

limit

integer · min: 1 · max: 50

Number of items per page (max 50)

Default: 10

direction

string · enum

Sort direction

Enum values:

desc

asc

Default: desc

filter

string · enum

Filter results

Enum values:

archived

all

Get all phone validator bulk operations › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get all phone validator bulk operations › Responses

200

List of bulk operations

object[]

object

GET/bulk/phone-validator

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-validator \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ],
  "meta": {
    "total": 0,
    "pageSize": 0,
    "current": 0,
    "total_pages": 0
  }
}

application/json

Create new phone validator bulk operation

POST

https://api.tomba.io/v1

/bulk/phone-validator

Create new phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Create new phone validator bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

file

string · required

CSV file for phone validation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

column_phone

integer

Phone number column

column_country

integer

Country column

Create new phone validator bulk operation › Responses

Bulk operation created successfully

object

POST/bulk/phone-validator

curl --request POST \
  --url https://api.tomba.io/v1/bulk/phone-validator \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --form name=name \
  --form list=list \
  --form sources=true \
  --form notifie=true \
  --form verify=true \
  --form total=0 \
  --form delimiter=delimiter \
  --form valid=true \
  --form column=0 \
  --form column_phone=0 \
  --form column_country=0 \
  --form file=file

Example Request Body

{
  "name": "name",
  "list": "list",
  "sources": true,
  "notifie": true,
  "verify": true,
  "total": 0,
  "delimiter": "delimiter",
  "valid": true,
  "column": 0,
  "column_phone": 0,
  "column_country": 0,
  "file": "file"
}

Example Responses

{
  "data": {
    "id": 0
  }
}

application/json

Get specific phone validator bulk operation

GET

https://api.tomba.io/v1

/bulk/phone-validator/{id}

Get specific phone validator bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Get specific phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get specific phone validator bulk operation › Responses

200

Bulk operation details

object[]

GET/bulk/phone-validator/{id}

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": [
    {
      "bulk_id": 0,
      "name": "name",
      "maximum": "maximum",
      "email_type": "email_type",
      "department": "department",
      "sources": true,
      "file_name": "file_name",
      "total": 0,
      "total_list": 0,
      "status": true,
      "chart": {},
      "table": {},
      "created_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "launched": true,
      "used": true,
      "time_track": "time_track",
      "progress": 0,
      "verify": true,
      "verify_cost": 0,
      "total_emails": 0,
      "processed": 0,
      "expired_at": "2024-08-25T15:00:00Z",
      "expired": true,
      "bulk_type": "bulk_type"
    }
  ]
}

application/json

Launch phone validator bulk operation

PUT

https://api.tomba.io/v1

/bulk/phone-validator/{id}

Launch phone validator bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Launch phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Launch phone validator bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/phone-validator/{id}

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Delete phone validator bulk operation

DELETE

https://api.tomba.io/v1

/bulk/phone-validator/{id}/delete

Delete phone validator bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Delete phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Delete phone validator bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/phone-validator/{id}/delete

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id/delete \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Archive phone validator bulk operation

DELETE

https://api.tomba.io/v1

/bulk/phone-validator/{id}/archive

Archive phone validator bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Archive phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Archive phone validator bulk operation › Responses

200

Operation completed successfully

object

DELETE/bulk/phone-validator/{id}/archive

curl --request DELETE \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id/archive \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Get phone validator bulk operation progress

GET

https://api.tomba.io/v1

/bulk/phone-validator/{id}/progress

Get phone validator bulk operation progress › path Parameters

id

integer · int64 · required

Bulk operation ID

Get phone validator bulk operation progress › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Get phone validator bulk operation progress › Responses

200

Bulk operation progress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

GET/bulk/phone-validator/{id}/progress

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id/progress \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

{
  "status": true,
  "progress": 0,
  "processed": 0
}

application/json

Download phone validator bulk results

GET

https://api.tomba.io/v1

/bulk/phone-validator/{id}/download

Download phone validator bulk results › path Parameters

id

integer · int64 · required

Bulk operation ID

Download phone validator bulk results › query Parameters

type

string · enum

Type of download file

Enum values:

full

not_found

valid

Default: full

Download phone validator bulk results › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Download phone validator bulk results › Responses

200

CSV file download

string

GET/bulk/phone-validator/{id}/download

curl --request GET \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id/download \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx'

Example Responses

string

text/csv

Rename phone validator bulk operation

PUT

https://api.tomba.io/v1

/bulk/phone-validator/{id}/rename

Rename phone validator bulk operation › path Parameters

id

integer · int64 · required

Bulk operation ID

Rename phone validator bulk operation › Headers

X-Tomba-Key

string · required

Tomba API Key X-Tomba-Key header. Format: YOUR_API_KEY

X-Tomba-Secret

string · required

Tomba API Secret X-Tomba-Secret header. Format: YOUR_API_SECRET

Rename phone validator bulk operation › Request Body

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

Rename phone validator bulk operation › Responses

200

Operation completed successfully

object

PUT/bulk/phone-validator/{id}/rename

curl --request PUT \
  --url https://api.tomba.io/v1/bulk/phone-validator/:id/rename \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "status": true,
    "message": "message",
    "code": 0
  }
}

application/json

Phone Enrichment