Tomba

Leads

Endpointhttps://api.tomba.io/v1

Retrieve Leads

GET

https://api.tomba.io/v1

/leads

Retrieve a paginated list of leads. Optionally filter by domain.

Retrieve Leads › query Parameters

domain

string

Filter leads by domain.

page

integer

Page number.

Default: 1

limit

integer

Number of leads per page.

Default: 10

Retrieve Leads › 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

Retrieve Leads › Responses

200

A list of leads.

object[]

object

GET/leads

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0
  }
}

json

application/json

Retrieve a Single Lead

GET

https://api.tomba.io/v1

/leads/{leadId}

Retrieve detailed information for a specific lead.

Retrieve a Single Lead › path Parameters

leadId

string · required

The ID of the lead.

Retrieve a Single Lead › 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

Retrieve a Single Lead › Responses

A lead object.

id

string · required

email

string · required

firstName

string

lastName

string

company

string

title

string

object[]

GET/leads/{leadId}

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

shell

Example Responses

{
  "id": "id",
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "company": "company",
  "title": "title",
  "attributes": [
    {
      "id": "id",
      "name": "name",
      "value": "value"
    }
  ]
}

json

application/json

Update a lead

PUT

https://api.tomba.io/v1

/leads/{leadId}

Update the fields of a lead using id.

Update a lead › path Parameters

leadId

string · required

The ID of the lead.

Update a lead › 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

Update a lead › Responses

A lead object.

id

string · required

email

string · required

firstName

string

lastName

string

company

string

title

string

object[]

PUT/leads/{leadId}

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

shell

Example Responses

{
  "id": "id",
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "company": "company",
  "title": "title",
  "attributes": [
    {
      "id": "id",
      "name": "name",
      "value": "value"
    }
  ]
}

json

application/json

Delete a lead

DELETE

https://api.tomba.io/v1

/leads/{leadId}

Delete a lead using id.

Delete a lead › path Parameters

leadId

string · required

The ID of the lead.

Delete a lead › 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 a lead › Responses

Lead deleted successfully

object

DELETE/leads/{leadId}

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

shell

Example Responses

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

json

application/json

Enrichment Lead Attributes

Retrieve Leads

GET

https://api.tomba.io/v1

/leads

Retrieve a paginated list of leads. Optionally filter by domain.

Retrieve Leads › query Parameters

domain

string

Filter leads by domain.

page

integer

Page number.

Default: 1

limit

integer

Number of leads per page.

Default: 10

Retrieve Leads › 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

Retrieve Leads › Responses

200

A list of leads.

object[]

object

Retrieve a Single Lead

GET

https://api.tomba.io/v1

/leads/{leadId}

Retrieve detailed information for a specific lead.

Retrieve a Single Lead › path Parameters

leadId

string · required

The ID of the lead.

Retrieve a Single Lead › 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

Retrieve a Single Lead › Responses

A lead object.

id

string · required

email

string · required

firstName

string

lastName

string

company

string

title

string

object[]

Update a lead

PUT

https://api.tomba.io/v1

/leads/{leadId}

Update the fields of a lead using id.

Update a lead › path Parameters

leadId

string · required

The ID of the lead.

Update a lead › 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

Update a lead › Responses

A lead object.

id

string · required

email

string · required

firstName

string

lastName

string

company

string

title

string

object[]

Delete a lead

DELETE

https://api.tomba.io/v1

/leads/{leadId}

Delete a lead using id.

Delete a lead › path Parameters

leadId

string · required

The ID of the lead.

Delete a lead › 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 a lead › Responses

Lead deleted successfully

object