Arlo

REST Auth API: Leads

Supported in next release

'Lead' resources represent a sales opportunity at a certain point in its lifecycle.

This resource supports retrieval of individual lead instances and collections of leads (with filters)

Lead instance resource

Resource URI

/api/2012-02-01/auth/resources/leads/{LeadID}/

Resource properties

Property Description
LeadID An integer value that uniquely identifies this resource within the platform.
Topic A string representing the topic of this lead, up to 256 characters long.
Category A string representing the category of this lead, up to 32 characters long.
Information A string representing ancillary information regarding this lead, of potentially unlimited size.
Type A LeadType string representing the type of the lead instance.
Status A LeadStatus string representing the status of this lead.
Value A decimal (money) value representing the projected or possible value of this lead.
ValueIsTaxExclusive If this lead has a value, this element will have a value of true or false; being true if the value stated is tax exclusive.
ValueCurrencyCode A currency of the value.
Location A string representation of the location of this lead, up to 256 characters long.
Source A string representation of the source of this lead, up to 256 characters long.
EstimatedCloseDateTime A UTC DateTime value indicating when this lead is likely to be closed.
ClosedDateTime A UTC DateTime value indicating when this lead was closed.
Stage A string representing the stage of this lead, such as Identified, Validated and so on, of up to 32 characters.
Rating A string denoting the rating of this lead, such as warm, hot and so on, of up to 32 characters.
CreatedDateTime A UTC DateTime value indicating when this resource was created. This field is read-only.
LastModifiedDateTime A UTC DateTime value indicating when this resource was last modified. This field is read-only.

HTTP GET

Returns a representation of a Lead, including the properties and links above.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
Example

GET /api/2012-02-01/auth/resources/leads/1792/

                            
<?xml version="1.0" encoding="utf-8"?>
<Lead>
  <LeadID>1</LeadID>
  <Topic>Rapid Reading for Business</Topic>
  <Category>Existing course</Category>
  <Type>ExistingEvent</Type>
  <Status>Open</Status>
  <Value>1595.00</Value>
  <ValueIsTaxExclusive>true</ValueIsTaxExclusive>
  <ValueCurrencyCode>AUD</ValueCurrencyCode>
  <CreatedDateTime>2011-09-12T13:53:47.007Z</CreatedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/1/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PrimaryContact" type="application/xml" title="PrimaryContact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/10650/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Organisation" type="application/xml" title="Organisation" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/9073/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Region" type="application/xml" title="Region" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/1/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/EventTemplates" type="application/xml" title="EventTemplates" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/1/eventtemplates/"/>
  <Link rel="related" type="application/xml" title="Metadata" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lead/describe/"/>
</Lead>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Lead collection resource

The Lead collection resource represents the set of Lead resources on the platform.

Resource URI

/api/2012-02-01/auth/resources/leads/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual Lead resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
filter A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions:
  • Value
  • Topic
  • Category
  • Type
  • Location
  • Source
  • Stage
  • Rating
  • DateClosed
  • CreatedDateTime
  • LastModifiedDateTime
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • Value
  • Topic
  • Category
  • Type
  • Location
  • Source
  • Stage
  • Rating
  • DateClosed
  • CreatedDateTime
  • LastModifiedDateTime
skip Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The skip and top parameters are generally used for collection paging.
top Returns a subset of records from the collection, starting at index 0 or index skip, and returns the first N records. The skip and top parameters are generally used for collection paging.
Example 1

Retrieve a collection of Lead links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/leads/

<Leads>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Organisation" type="application/xml" title="Organisation" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/823/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Organisation" type="application/xml" title="Organisation" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/824/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Organisation" type="application/xml" title="Organisation" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/825/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Organisation" type="application/xml" title="Organisation" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/826/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/leads/"/>
</Leads>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.