Get an organization lead intake source by ID

curl --request GET \
  --url https://api.leadping.ai/sources/{id} \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/sources/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/sources/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/sources/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/sources/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "description": "<string>",
  "enabled": true,
  "apiKeyPreview": "<string>",
  "apiKeyRotatedAt": "2023-11-07T05:31:56Z",
  "firstLeadReceivedAt": "2023-11-07T05:31:56Z",
  "lastLeadReceivedAt": "2023-11-07T05:31:56Z",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdByUser": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdByUserEmail": "jsmith@example.com",
  "modifiedByUser": {
    "id": "<string>",
    "name": "<string>"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "costPerLead": 123,
  "allowedStates": [
    "<string>"
  ],
  "allowedProducts": [
    "<string>"
  ],
  "requiresTrustedForm": true,
  "complianceApproved": true,
  "defaultTagIds": [
    "<string>"
  ],
  "defaultTags": [
    {
      "id": "<string>",
      "name": "<string>",
      "normalizedName": "<string>",
      "color": "<string>"
    }
  ],
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

GET

sources

{id}

Get an organization lead intake source by ID

curl --request GET \
  --url https://api.leadping.ai/sources/{id} \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/sources/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/sources/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/sources/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/sources/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "description": "<string>",
  "enabled": true,
  "apiKeyPreview": "<string>",
  "apiKeyRotatedAt": "2023-11-07T05:31:56Z",
  "firstLeadReceivedAt": "2023-11-07T05:31:56Z",
  "lastLeadReceivedAt": "2023-11-07T05:31:56Z",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdByUser": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdByUserEmail": "jsmith@example.com",
  "modifiedByUser": {
    "id": "<string>",
    "name": "<string>"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "costPerLead": 123,
  "allowedStates": [
    "<string>"
  ],
  "allowedProducts": [
    "<string>"
  ],
  "requiresTrustedForm": true,
  "complianceApproved": true,
  "defaultTagIds": [
    "<string>"
  ],
  "defaultTags": [
    {
      "id": "<string>",
      "name": "<string>",
      "normalizedName": "<string>",
      "color": "<string>"
    }
  ],
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

Authorizations

Authorization

string

header

required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

string

required

The ID of the source to retrieve.

Response

Source was successfully retrieved.

Describes lead source data returned by Leadping.

description

null | string

Human-readable description that explains this lead source response to API users.

enabled

boolean

Indicates whether this lead source response is active and available in the Leadping API.

apiKeyPreview

null | string

Masked preview of the source API key for compact display.

apiKeyRotatedAt

null | string<date-time>

UTC timestamp when the source credential was most recently rotated.

firstLeadReceivedAt

null | string<date-time>

UTC timestamp when this source first delivered a lead to Leadping.

lastLeadReceivedAt

null | string<date-time>

UTC timestamp when this source most recently delivered a lead to Leadping.

user

object | null

User summary connected to this lead source response.

Show child attributes

createdByUser

object | null

User summary for the person who created this lead source response.

Show child attributes

createdByUserEmail

null | string<email>

Email used to resolve the creator's avatar.

modifiedByUser

object | null

User summary for the person who last modified this lead source response.

Show child attributes

organization

object | null

Organization summary connected to this lead source response.

Show child attributes

costPerLead

null | number<double>

Configured cost charged when this source creates a billable lead.

allowedStates

string[]

State or region allowlist used to accept leads from this source.

allowedProducts

string[]

Product allowlist used to accept or route leads from this source.

requiresTrustedForm

boolean

Indicates whether leads from this source must include a TrustedForm certificate for consent proof.

complianceApproved

boolean

Indicates whether the organization or sender passed compliance review.

defaultTagIds

string[]

Tag IDs automatically assigned to leads created by this source.

defaultTags

object[]

Default tag summaries automatically applied to leads from this source.

Show child attributes

name

string

Human-readable display name of the resource.

string

Stable unique identifier of the resource.

createdAt

string<date-time>

UTC timestamp when the resource was created.

modifiedAt

null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.

API Overview

Endpoints

Get an organization lead intake source by ID

Authorizations

Path Parameters

Response