Get a single Lead Export

GET

https://api.close.com/api/v1/export/lead/:id/

GET

/api/v1/export/lead/:id/

curl https://api.close.com/api/v1/export/lead/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-04-02T15:00:05.190000+00:00",
  "date_format": "iso8601",
  "date_updated": "2014-04-02T23:36:30.719000+00:00",
  "download_url": "https://close-exports.s3.amazonaws.com/expo_yasd512lkhIhxrvLG8iVupzjoJVRPgrGhJ0A0b3bae.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=60&X-Amz-Signature=EXAMPLE",
  "fields": [
    "addresses",
    "contacts",
    "created_by",
    "created_by_name",
    "custom",
    "date_created",
    "date_updated",
    "description",
    "display_name",
    "id",
    "name",
    "status_id",
    "status_label",
    "updated_by",
    "updated_by_name",
    "url"
  ],
  "format": "csv",
  "id": "expo_yasd512lkhIhxrvLG8iVupzjoJVRPgrGhJ0A0b3bae",
  "n_docs": 100000,
  "n_docs_processed": 100000,
  "organization_id": "orga_klasjd123vxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "send_done_email": false,
  "status": "done",
  "type": "leads",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "results_limit": null,
  "s_query": {
    "queries": [
      {
        "object_type": "lead",
        "type": "object_type"
      },
      {
        "condition": {
          "mode": "full_words",
          "type": "text",
          "value": "ACME Inc."
        },
        "field": {
          "field_name": "name",
          "object_type": "lead",
          "type": "regular_field"
        },
        "type": "field_condition"
      }
    ],
    "type": "and"
  },
  "sort": []
}

Get a single lead export to do things like check its status or get a download_url.

status can have one of these values: created, started, in_progress, done, error.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

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

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

created_bystring or null

date_createddatetime

date_formatenum

date_updateddatetime

download_urlstring or null

fieldslist of strings

formatenum

idstring

n_docsinteger or null

n_docs_processedinteger

organization_idstring

send_done_emailboolean

statusenum

typeenum

updated_bystring or null

limitinteger or nullOptional

paramsmap from strings to nullable maps from strings to JSON or lists of JSON or strings or integers or doubles or booleans or nullOptional

querystring or nullOptional

results_limitinteger or nullOptional

s_querymap from strings to nullable maps from strings to JSON or lists of JSON or strings or integers or doubles or booleans or nullOptional

sortlist of maps from strings to nullable JSONDict or lists of JSON or strings or integers or doubles or booleans or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error