Lead-Files

Get lead file by ID

Retrieve a specific lead file by its id.

When to use. Look up a single lead file when you already know its id. To list every lead file, use GET /lead-files.

Parameters. id (path, required) is the id of the lead file to retrieve. You can also filter, order, limit and select fields by any response field. See Core API Concepts.

Returns. { "lead_files": [ ... ] }, where each entry has id, name and created_at.

Example. GET /api/lead-files/id/5

get/{sub_domain}/api/lead-files/id/{id}

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/lead-files/id/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Lead File ID.

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

Example response

{
  "lead_files": [
    {
      "created_at": "2019-03-05 08:09:59",
      "id": 174,
      "name": "Demo Leads"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.