Skip to content

APIs

Files

New File

Method

POST /files

Payload

{
  "api_key": "XXX",
  "file": {
    "name": "test.csv",
    "headers": ["email_address"],
    "num_rows": 1
  }
}

Response

{
  "id": 1234,
  "upload_url": "http://unique.upload.url/"
}

Enrichments

New Enrichment

Method

POST /enrichments

Payload

{
  "api_key": "XXX",
  "enrichment": {
    "name": "Enrichment Name",
    "providers": ["domain_from_email"],
    "file_id": 1234
  }
}

Response

{
  "id": 54321
}

Show Enrichment Status

Method

GET /enrichments/:id

Response

{
  "id": 15,
  "name": "Enrichment 32427",
  "state": "complete",
  "providers": [ "domain_from_email" ],
  "input_file": {
    "id": 16,
    "name": "my_input_file-6669.csv",
    "num_rows": 10,
    "headers": [
      "email_address"
    ]
  },
  "download_files": [
    {
      "provider": "domain_from_email",
      "download_url": "https://url/"
    }
  ]
}

state

can be uploading, running, error, complete