MMT API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

MMT Reports API documentation.

Base URLs:

https://api.mymosttrusted.net/v1

License: Apache 2.0

Introduction

Welcome to the My Most Trussted Reports API! You can use our API to access data belonging to your agency(ies).

We have language bindings in Java, Ruby, Python, Python, C#, PHP, bare http, and JavaScript! We also have an android client SDK available from https://github.com/mymosttrusted/mmt-android. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer sk-nnf87678978_4eC39HqLyjWDarjtT1zdp7dc"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authentication

HTTP Authentication, scheme: bearer

Networks

Everything about the networks you can access

Retrieve a list of networks you can access

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network', headers = headers)

print(r.json())

GET /v1/network HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
from_date	query	string	false	Get a list accessible networks created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "network_name": "string",
      "created": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of networks (id and name) you can access	NetworkResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Status	Meaning	Description	Schema
200	OK	A List of tags	TagResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Status	Meaning	Description	Schema
200	OK	A List of tags	TagResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Stats

Statistics on a network

Get Summary on Available tracking links and tags summary

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/stats/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/stats/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/stats/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/stats/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/stats/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/stats/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/stats/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/stats/{user_id}

Returns clicks statistics for tracking links and tag summary

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user in case of a specific user stats
from_date	query	string	false	Get invites created from this date onwards

Example responses

200 Response

{
  "invites": {
    "status": [
      {
        "status_name": "Pending",
        "total": 5
      }
    ],
    "total": 5
  },
  "tracking_links": [
    {
      "id": 1,
      "link": "string",
      "tracking_link_name": "string",
      "clicked": 1,
      "unclicked": 1,
      "total": 2
    }
  ],
  "tags": [
    {
      "id": 1,
      "tag_name": "string",
      "total": 1
    }
  ],
  "users": 1
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of tracking link and tags statistics	UserStatsResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Get Summary on invites

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/stats/invites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/stats/invites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/stats/invites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/stats/invites',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/stats/invites', headers = headers)

print(r.json())

GET /v1/network/{network_id}/stats/invites HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/stats/invites";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/stats/invites

Returns invites summary by users

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
first_name	query	string	false	Search for invite stats by first name
last_name	query	string	false	Search for invite stats by last name
user_id	query	string	false	Search for invite stats by user_id
from_date	query	string	false	Get invites created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "total": 1,
      "tracking_links": {
        "clicked": 1,
        "unclicked": 1,
        "total": 2
      },
      "tags": [
        {
          "tag_name": "Invited",
          "total": 1
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of tracking link and tags statistics	StatsResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

TrackingLink

Everything tracking links for the networks you can access

Get detailed tracking link list logged for the network with id {id}

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/tracking_links',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/tracking_links");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/tracking_links', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/tracking_links',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/tracking_links', headers = headers)

print(r.json())

GET /v1/network/{network_id}/tracking_links HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/tracking_links";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/tracking_links

Returns a list of tracking link logged for the network with id {id}

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
tracking_link_name	query	string	false	Get tracking links with name matching tracking_link_name
from_date	query	string	false	Get tracking links created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "link": "string",
      "tracking_link_name": "string",
      "created": "string",
      "clicked": "string",
      "tracking_link": "string",
      "first_name": "string",
      "last_name": "string",
      "li_user_id": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of tracking links	TrackingLinkDetailResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Get detailed tracking link list logged for the network with id {id} by user with linkedin id li_user_id

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/tracking_links/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/tracking_links/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/tracking_links/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/tracking_links/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/tracking_links/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/tracking_links/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/tracking_links/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/tracking_links/{user_id}

Returns a list of tracking link logged for the network with id {id} by user with linkedin id li_user_id

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user in case of a specific user stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
tracking_link_name	query	string	false	Get tracking links with name matching tracking_link_name
from_date	query	string	false	Get tracking links created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "link": "string",
      "tracking_link_name": "string",
      "created": "string",
      "clicked": "string",
      "tracking_link": "string",
      "first_name": "string",
      "last_name": "string",
      "li_user_id": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of tracking links	TrackingLinkDetailResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Users

Everything user for the networks you can access

Get a list of available users

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/users', headers = headers)

print(r.json())

GET /v1/network/{network_id}/users HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/users";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/users

Returns a list of users in the network

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
first_name	query	string	false	Search for users by first name
last_name	query	string	false	Search for users by last name
position	query	string	false	Search for users by position
email	query	string	false	Search for users by email
phone_number	query	string	false	Search for users by phone_number
country	query	string	false	Search for users by country
activation_id	query	string	false	Search for users by activation reference

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "activation_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "li_link": "string",
      "position": "string",
      "last_work_text": "string",
      "country": "string",
      "created": "string",
      "deactivated": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of network users	UserResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Webhook

Endpoints for creating, updating and removing the webhooks

Get the current webhook configurations for user

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/webhook/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/webhook/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/webhook/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/webhook/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/webhook/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/webhook/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/webhook/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/webhook/{user_id}

Returns the current webhook configurations for user

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the webhook
user_id	path	string	true	LinkedIn identifier for the user's configurations
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
webhook_url	query	string(uri)	false	The user's associated search url configuration for the network configuration you're viewing
from_date	query	string	false	Get webhooks created from this date onwards
from_date_updated	query	string	false	Get webhooks updated from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "webhook_id": 100,
      "network_id": 1,
      "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
      "tag_name": "Push to CRM",
      "created": "2022-01-01T00:30:36Z",
      "updated": "2022-01-01T17:30:36Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The current webhook configurations for user	WebhookResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Configure webhook for a user

Code samples

const inputBody = '{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/webhook/{user_id}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/webhook/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/network/{network_id}/webhook/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/network/{network_id}/webhook/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/network/{network_id}/webhook/{user_id}', headers = headers)

print(r.json())

POST /v1/network/{network_id}/webhook/{user_id} HTTP/1.1

Content-Type: application/json
Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/network/{network_id}/webhook/{user_id}";

      string json = @"{
  ""tag_name"": ""Push to CRM"",
  ""webhook_url"": ""https://webhook.mymosttrusted.net?fid=1323""
}";
      WebhookBody content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(WebhookBody content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(WebhookBody content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /network/{network_id}/webhook/{user_id}

Configures webhook for a user

Body parameter

{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the webhook
user_id	path	string	true	LinkedIn identifier for the user's configurations
body	body	WebhookBody	false	none

Example responses

200 Response

{
  "code": 200,
  "message": "Success"
}

Responses

Status	Meaning	Description	Schema
200	OK	The webhook sent for configuration was successfully updated	OkResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None
409	Conflict	Your request was made with valid data but there is a duplicate record.	None

Update webhook for a user

Code samples

const inputBody = '{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/webhook/{webhook_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/webhook/{webhook_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/network/{network_id}/webhook/{webhook_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/network/{network_id}/webhook/{webhook_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/network/{network_id}/webhook/{webhook_id}', headers = headers)

print(r.json())

PUT /v1/network/{network_id}/webhook/{webhook_id} HTTP/1.1

Content-Type: application/json
Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }



    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/network/{network_id}/webhook/{webhook_id}";


      string json = @"{
  ""tag_name"": ""Push to CRM"",
  ""webhook_url"": ""https://webhook.mymosttrusted.net?fid=1323""
}";
      WebhookPatchBody content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);


    }

    /// Performs a PUT Request
    public async Task PutAsync(int id, WebhookPatchBody content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);

        //Return response
        return await DeserializeObject(response);
    }


    /// Serialize an object to Json
    private StringContent SerializeObject(WebhookPatchBody content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /network/{network_id}/webhook/{webhook_id}

Updates webhook for a user

Body parameter

{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the webhook
webhook_id	path	integer	true	ID of the webhook to update
body	body	WebhookPatchBody	false	none

Example responses

200 Response

{
  "code": 200,
  "message": "Success"
}

Responses

Status	Meaning	Description	Schema
200	OK	The webhook sent for configuration was successfully updated	OkResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Delete webhook for a user

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/webhook/{webhook_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/webhook/{webhook_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/network/{network_id}/webhook/{webhook_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/network/{network_id}/webhook/{webhook_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/network/{network_id}/webhook/{webhook_id}', headers = headers)

print(r.json())

DELETE /v1/network/{network_id}/webhook/{webhook_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/network/{network_id}/webhook/{webhook_id}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /network/{network_id}/webhook/{webhook_id}

Deletes webhook for a user

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the webhook
webhook_id	path	integer	true	ID of the webhook to delete

Example responses

200 Response

{
  "code": 200,
  "message": "Success"
}

Responses

Status	Meaning	Description	Schema
200	OK	The webhook sent for configuration was successfully deleted	OkResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Config

Search URL and messages configurations

Get the current search url and messages configurations for user

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/config/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/config/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/config/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/config/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/config/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/config/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/config/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/config/{user_id}

Returns the current search url and messages configurations for user

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user's configurations

Example responses

200 Response

{
  "network_id": 1,
  "search_url": "https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4",
  "invitation_message": "Invitation Message sample",
  "acceptance_message": "Acceptance Message sample",
  "custom_message1": "Custom Message 1 sample",
  "custom_message2": "Custom Message 2 sample"
}

Responses

Status	Meaning	Description	Schema
200	OK	The current search url and messages configurations for user	ConfigResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Configure search url and messages for a user

Code samples

const inputBody = '{
  "search_url": "https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4",
  "invitation_message": "Invitation Message sample",
  "acceptance_message": "Acceptance Message sample",
  "custom_message1": "Custom Message 1 sample",
  "custom_message2": "Custom Message 2 sample"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/config/{user_id}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/config/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/network/{network_id}/config/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/network/{network_id}/config/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/network/{network_id}/config/{user_id}', headers = headers)

print(r.json())

POST /v1/network/{network_id}/config/{user_id} HTTP/1.1

Content-Type: application/json
Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/network/{network_id}/config/{user_id}";

      string json = @"{
  ""search_url"": ""https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4"",
  ""invitation_message"": ""Invitation Message sample"",
  ""acceptance_message"": ""Acceptance Message sample"",
  ""custom_message1"": ""Custom Message 1 sample"",
  ""custom_message2"": ""Custom Message 2 sample""
}";
      ConfigBody content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(ConfigBody content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(ConfigBody content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /network/{network_id}/config/{user_id}

Configures search url and messages for a user

Body parameter

{
  "search_url": "https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4",
  "invitation_message": "Invitation Message sample",
  "acceptance_message": "Acceptance Message sample",
  "custom_message1": "Custom Message 1 sample",
  "custom_message2": "Custom Message 2 sample"
}

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user's configurations
body	body	ConfigBody	false	none

Example responses

200 Response

{
  "code": 200,
  "message": "Success"
}

Responses

Status	Meaning	Description	Schema
200	OK	The search url and messages sent for configuration were successfully updated	OkResult
400	Bad Request	Your request does not match the specified format	None
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Invites

Everything invites for the networks you can access

Get summarised invites listed in network

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/invites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/invites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/invites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/invites',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/invites', headers = headers)

print(r.json())

GET /v1/network/{network_id}/invites HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/invites";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/invites

Returns a list of invites listed in network

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
li_user_id	query	string	false	Get invite specific to li_user_id
first_name	query	string	false	Get tags specific to an invite first name
last_name	query	string	false	Get tags specific to an invite last name
tag_name	query	string	false	Get invites with this tag name
status_name	query	string	false	Get invites specific to this status
from_date	query	string	false	Get invites created from this date onwards
from_date_updated	query	string	false	Get invites created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "created": "string",
      "li_link": "string",
      "li_user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "position": "string",
      "company": "string",
      "country": "string",
      "webhooks": [
        {
          "tag_name": "string",
          "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
          "created": "string",
          "http_response": 200
        }
      ],
      "tags": [
        {
          "id": 1,
          "tag_name": "string",
          "created": "string"
        }
      ],
      "status_name": "string",
      "updated": "string",
      "user_id": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of invites by user with id li_user_id in this network	InvitesResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Get contacts listed by specific user

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/invites/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/invites/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/invites/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/invites/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/invites/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/invites/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/invites/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/invites/{user_id}

Returns a list of contacts listed by the user with LinkedIn id li_user_id

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user in case of a specific user stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
li_user_id	query	string	false	Get invites specific to an invite li_user_id
first_name	query	string	false	Get tags specific to an invite first name
last_name	query	string	false	Get tags specific to an invite last name
tag_name	query	string	false	Get invites specific to this tag name
status	query	string	false	Get invites specific to this status
from_date	query	string	false	Get invites created from this date onwards
from_date_updated	query	string	false	Get invites created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "created": "string",
      "li_link": "string",
      "li_user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "position": "string",
      "company": "string",
      "country": "string",
      "webhooks": [
        {
          "tag_name": "string",
          "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
          "created": "string",
          "http_response": 200
        }
      ],
      "tags": [
        {
          "id": 1,
          "tag_name": "string",
          "created": "string"
        }
      ],
      "status_name": "string",
      "updated": "string",
      "user_id": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of invites by user with id li_user_id in this network	InvitesResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Connect

Eveything contact for to connect tab of the extension

Get summarised to connect contacts listed in network

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/connects',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/connects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/connects', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/connects',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/connects', headers = headers)

print(r.json())

GET /v1/network/{network_id}/connects HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/connects";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/connects

Returns a list of to connect contacts listed in network

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
li_user_id	query	string	false	Get invite specific to li_user_id
first_name	query	string	false	Find to connect contacts with first names alike to this first name
last_name	query	string	false	Find to connect contacts with last names alike to this last name
location	query	string	false	Find to connect contacts in location alike to this location
from_date	query	string	false	Get to connect contacts created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "thumbnail": "string",
      "thumbnail_id": "string",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "li_link": "string",
      "li_user_id": "string",
      "position": "string",
      "location": "string",
      "country": "string",
      "website": "string",
      "search_url": "string",
      "created": "string",
      "updated": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of to connect contacts in this network	ConnectUserResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Get to connect contacts listed by specific user

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/connects/{user_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/connects/{user_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/connects/{user_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/connects/{user_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/connects/{user_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/connects/{user_id} HTTP/1.1

Accept: application/json

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/connects/{user_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/connects/{user_id}

Returns a list of to connect contacts listed by the user with LinkedIn id li_user_id

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
user_id	path	string	true	LinkedIn identifier for the user in case of a specific user stats
page	query	integer	false	Page to fetch
limit	query	integer	false	Number of records to return per page, maximum allowed number is 50
li_user_id	query	string	false	Get to connect contacts specific to an invite li_user_id
first_name	query	string	false	Find to connect contacts with first names alike to this first name
last_name	query	string	false	Find to connect contacts with last names alike to this last name
location	query	string	false	Find to connect contacts in location alike to this location
from_date	query	string	false	Get to connect contacts created from this date onwards

Example responses

200 Response

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "thumbnail": "string",
      "thumbnail_id": "string",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "li_link": "string",
      "li_user_id": "string",
      "position": "string",
      "location": "string",
      "country": "string",
      "website": "string",
      "search_url": "string",
      "created": "string",
      "updated": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of to connect contacts by user with id li_user_id in this network	ConnectUserResult
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Thumbnail

Retrieve the thumbnail for contact

Get photo for the user_id specified by thumb_id

Code samples


const headers = {
  'Accept':'image/png',
  'Authorization':'Bearer {access-token}'
};

fetch('/v1/network/{network_id}/thumbnail/{thumbnail_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/v1/network/{network_id}/thumbnail/{thumbnail_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'image/png',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/network/{network_id}/thumbnail/{thumbnail_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'image/png',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network_id}/thumbnail/{thumbnail_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'image/png',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network_id}/thumbnail/{thumbnail_id}', headers = headers)

print(r.json())

GET /v1/network/{network_id}/thumbnail/{thumbnail_id} HTTP/1.1

Accept: image/png

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/network/{network_id}/thumbnail/{thumbnail_id}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /network/{network_id}/thumbnail/{thumbnail_id}

Returns a photo for the user_id specified by thumb_id

Parameters

Name	In	Type	Required	Description
network_id	path	integer	true	Network ID for the stats
thumbnail_id	path	string	true	LinkedIn identifier related to the thumbnail

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	A List of to connect contacts by user with id li_user_id in this network	string
401	Unauthorized	Your request was made with invalid credentials.	None
403	Forbidden	You're not supposed to access this resource.	None

Schemas

Network

{
  "id": 1,
  "network_name": "string",
  "created": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
network_name	string	false	none	none
created	string	false	none	none

OkResult

{
  "code": 200,
  "message": "Success"
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	200 represents success, all else unsuccessful
message	string	false	none	The message that comes about the status of the configuration update

ConfigResult

{
  "network_id": 1,
  "search_url": "https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4",
  "invitation_message": "Invitation Message sample",
  "acceptance_message": "Acceptance Message sample",
  "custom_message1": "Custom Message 1 sample",
  "custom_message2": "Custom Message 2 sample"
}

Properties

Name	Type	Required	Restrictions	Description
network_id	integer	false	none	The ID of the network configuration you're viewing
search_url	string(uri)	false	none	The user's associated search url configuration for the network configuration you're viewing
invitation_message	string	false	none	The invitation message template currently configured
acceptance_message	string	false	none	The acceptance message template currently configured
custom_message1	string	false	none	The custom message 1 template currently configured
custom_message2	string	false	none	The custom message 2 template currently configured

WebhookResultItem

{
  "webhook_id": 100,
  "network_id": 1,
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
  "tag_name": "Push to CRM",
  "created": "2022-01-01T00:30:36Z",
  "updated": "2022-01-01T17:30:36Z"
}

Properties

Name	Type	Required	Restrictions	Description
webhook_id	integer	false	none	none
network_id	integer	false	none	The ID of the network configuration you're viewing
webhook_url	string(uri)	false	none	The user's associated search url configuration for the network configuration you're viewing
tag_name	string	false	none	The tag/event currently configured for this webhook
created	string	false	none	none
updated	string	false	none	none

WebhookArray

[
  {
    "webhook_id": 100,
    "network_id": 1,
    "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
    "tag_name": "Push to CRM",
    "created": "2022-01-01T00:30:36Z",
    "updated": "2022-01-01T17:30:36Z"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[WebhookResultItem]	false	none	none

WebhookResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "webhook_id": 100,
      "network_id": 1,
      "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
      "tag_name": "Push to CRM",
      "created": "2022-01-01T00:30:36Z",
      "updated": "2022-01-01T17:30:36Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of networks
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[WebhookResultItem]	false	none	none

ConfigBody

{
  "search_url": "https://www.linkedin.com/search/results/all/?keywords=(risk%20OR%20compliance%20OR%20safety%20OR%20health)%20AND(manager%20OR%20director%20OR%20head)&origin=HISTORY&sid=eU4",
  "invitation_message": "Invitation Message sample",
  "acceptance_message": "Acceptance Message sample",
  "custom_message1": "Custom Message 1 sample",
  "custom_message2": "Custom Message 2 sample"
}

Properties

Name	Type	Required	Restrictions	Description
search_url	string(uri)	false	none	The user's associated search url configuration for the network configuration you're setting up
invitation_message	string	false	none	The invitation message template being configured
acceptance_message	string	false	none	The acceptance message template being configured
custom_message1	string	false	none	The custom message 1 template being configured
custom_message2	string	false	none	The custom message 2 template being configured

WebhookBody

{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}

Properties

Name	Type	Required	Restrictions	Description
tag_name	string	false	none	The tag associated with the webhook event being configured for the user you're setting up
webhook_url	string(uri)	false	none	The URL to receive the webhook events

WebhookPatchBody

{
  "tag_name": "Push to CRM",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323"
}

Properties

Name	Type	Required	Restrictions	Description
tag_name	string	false	none	The tag associated with the webhook event being configured for the user you're setting up
webhook_url	string(uri)	false	none	The new URL to receive the webhook events

NetworkResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "network_name": "string",
      "created": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of networks
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[Network]	false	none	none

NetworkArray

[
  {
    "id": 1,
    "network_name": "string",
    "created": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Network]	false	none	none

TrackingLinkDetailArray

[
  {
    "id": 1,
    "link": "string",
    "tracking_link_name": "string",
    "created": "string",
    "clicked": "string",
    "tracking_link": "string",
    "first_name": "string",
    "last_name": "string",
    "li_user_id": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[TrackingLinkDetail]	false	none	none

InvitesResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "created": "string",
      "li_link": "string",
      "li_user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "position": "string",
      "company": "string",
      "country": "string",
      "webhooks": [
        {
          "tag_name": "string",
          "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
          "created": "string",
          "http_response": 200
        }
      ],
      "tags": [
        {
          "id": 1,
          "tag_name": "string",
          "created": "string"
        }
      ],
      "status_name": "string",
      "updated": "string",
      "user_id": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of invites
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[Invite]	false	none	none

TrackingLinkDetailResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "link": "string",
      "tracking_link_name": "string",
      "created": "string",
      "clicked": "string",
      "tracking_link": "string",
      "first_name": "string",
      "last_name": "string",
      "li_user_id": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of invites
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[TrackingLinkDetail]	false	none	none

ConnectUserResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "thumbnail": "string",
      "thumbnail_id": "string",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "li_link": "string",
      "li_user_id": "string",
      "position": "string",
      "location": "string",
      "country": "string",
      "website": "string",
      "search_url": "string",
      "created": "string",
      "updated": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of invites
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[ConnectUser]	false	none	none

UserStatsResult

{
  "invites": {
    "status": [
      {
        "status_name": "Pending",
        "total": 5
      }
    ],
    "total": 5
  },
  "tracking_links": [
    {
      "id": 1,
      "link": "string",
      "tracking_link_name": "string",
      "clicked": 1,
      "unclicked": 1,
      "total": 2
    }
  ],
  "tags": [
    {
      "id": 1,
      "tag_name": "string",
      "total": 1
    }
  ],
  "users": 1
}

Properties

Name	Type	Required	Restrictions	Description
invites	object	false	none	none
» status	[InviteStatus]	false	none	none
» total	integer	false	none	none
tracking_links	[TrackingLinkSummary]	false	none	none
tags	[GroupedTagItem]	false	none	none
users	integer	false	none	none

StatsResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string",
      "total": 1,
      "tracking_links": {
        "clicked": 1,
        "unclicked": 1,
        "total": 2
      },
      "tags": [
        {
          "tag_name": "Invited",
          "total": 1
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of invites
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[StatsByUserInvites]	false	none	none

StatsSummedResult

{
  "invites": {
    "status": [
      {
        "status_name": "Pending",
        "total": 5
      }
    ],
    "total": 5
  },
  "tracking_links": {
    "clicked": 1,
    "unclicked": 1,
    "total": 2
  },
  "tags": 1,
  "users": 1
}

Properties

Name	Type	Required	Restrictions	Description
invites	object	false	none	none
» status	[InviteStatus]	false	none	none
» total	integer	false	none	none
tracking_links	object	false	none	none
» clicked	integer	false	none	none
» unclicked	integer	false	none	none
» total	integer	false	none	none
tags	integer	false	none	Total number of tags sent
users	integer	false	none	none

UserResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "user_id": "string",
      "activation_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": [
        {
          "phone_type": "mobile",
          "phone_number": "+44 (000) 111 111 111"
        }
      ],
      "li_link": "string",
      "position": "string",
      "last_work_text": "string",
      "country": "string",
      "created": "string",
      "deactivated": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of invites
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[User]	false	none	none

InviteArray

[
  {
    "id": 1,
    "created": "string",
    "li_link": "string",
    "li_user_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": [
      {
        "phone_type": "mobile",
        "phone_number": "+44 (000) 111 111 111"
      }
    ],
    "position": "string",
    "company": "string",
    "country": "string",
    "webhooks": [
      {
        "tag_name": "string",
        "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
        "created": "string",
        "http_response": 200
      }
    ],
    "tags": [
      {
        "id": 1,
        "tag_name": "string",
        "created": "string"
      }
    ],
    "status_name": "string",
    "updated": "string",
    "user_id": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Invite]	false	none	none

TagResult

{
  "total": 1,
  "page": 1,
  "limit": 50,
  "data": [
    {
      "id": 1,
      "created": "string",
      "tag_name": "string",
      "first_name": "string",
      "last_name": "string",
      "li_user_id": "string",
      "user_id": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	Total Number of tags
page	integer	false	none	Loaded page number
limit	integer	false	none	Items per page
data	[TagDetail]	false	none	none

TagDetailArray

[
  {
    "id": 1,
    "created": "string",
    "tag_name": "string",
    "first_name": "string",
    "last_name": "string",
    "li_user_id": "string",
    "user_id": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[TagDetail]	false	none	none

UserArray

[
  {
    "user_id": "string",
    "activation_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": [
      {
        "phone_type": "mobile",
        "phone_number": "+44 (000) 111 111 111"
      }
    ],
    "li_link": "string",
    "position": "string",
    "last_work_text": "string",
    "country": "string",
    "created": "string",
    "deactivated": 0
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[User]	false	none	none

ConnectUserArray

[
  {
    "user_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "thumbnail": "string",
    "thumbnail_id": "string",
    "phone": [
      {
        "phone_type": "mobile",
        "phone_number": "+44 (000) 111 111 111"
      }
    ],
    "li_link": "string",
    "li_user_id": "string",
    "position": "string",
    "location": "string",
    "country": "string",
    "website": "string",
    "search_url": "string",
    "created": "string",
    "updated": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[ConnectUser]	false	none	none

StatsArray

[
  {
    "user_id": "string",
    "first_name": "string",
    "last_name": "string",
    "total": 1,
    "tracking_links": {
      "clicked": 1,
      "unclicked": 1,
      "total": 2
    },
    "tags": [
      {
        "tag_name": "Invited",
        "total": 1
      }
    ]
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[StatsByUserInvites]	false	none	none

StatsByUserInvites

{
  "user_id": "string",
  "first_name": "string",
  "last_name": "string",
  "total": 1,
  "tracking_links": {
    "clicked": 1,
    "unclicked": 1,
    "total": 2
  },
  "tags": [
    {
      "tag_name": "Invited",
      "total": 1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
user_id	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
total	integer	false	none	none
tracking_links	object	false	none	none
» clicked	integer	false	none	none
» unclicked	integer	false	none	none
» total	integer	false	none	none
tags	[TagStats]	false	none	none

TagStats

{
  "tag_name": "Invited",
  "total": 1
}

Properties

Name	Type	Required	Restrictions	Description
tag_name	string	false	none	none
total	integer	false	none	none

User

{
  "user_id": "string",
  "activation_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "phone": [
    {
      "phone_type": "mobile",
      "phone_number": "+44 (000) 111 111 111"
    }
  ],
  "li_link": "string",
  "position": "string",
  "last_work_text": "string",
  "country": "string",
  "created": "string",
  "deactivated": 0
}

Properties

Name	Type	Required	Restrictions	Description
user_id	string	false	none	none
activation_id	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	false	none	none
phone	[PhoneItem]	false	none	none
li_link	string	false	none	none
position	string	false	none	none
last_work_text	string	false	none	none
country	string	false	none	none
created	string	false	none	none
deactivated	integer	false	none	none

ConnectUser

{
  "user_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "thumbnail": "string",
  "thumbnail_id": "string",
  "phone": [
    {
      "phone_type": "mobile",
      "phone_number": "+44 (000) 111 111 111"
    }
  ],
  "li_link": "string",
  "li_user_id": "string",
  "position": "string",
  "location": "string",
  "country": "string",
  "website": "string",
  "search_url": "string",
  "created": "string",
  "updated": "string"
}

Properties

Name	Type	Required	Restrictions	Description
user_id	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	false	none	none
thumbnail	string	false	none	none
thumbnail_id	string	false	none	none
phone	[PhoneItem]	false	none	none
li_link	string	false	none	none
li_user_id	string	false	none	none
position	string	false	none	none
location	string	false	none	none
country	string	false	none	none
website	string	false	none	none
search_url	string	false	none	none
created	string	false	none	none
updated	string	false	none	none

GroupedTagItem

{
  "id": 1,
  "tag_name": "string",
  "total": 1
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
tag_name	string	false	none	none
total	integer	false	none	none

WebhookItem

{
  "tag_name": "string",
  "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
  "created": "string",
  "http_response": 200
}

Properties

Name	Type	Required	Restrictions	Description
tag_name	string	false	none	none
webhook_url	string(uri)	false	none	none
created	string	false	none	none
http_response	integer	false	none	none

TagItem

{
  "id": 1,
  "tag_name": "string",
  "created": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
tag_name	string	false	none	none
created	string	false	none	none

PhoneItem

{
  "phone_type": "mobile",
  "phone_number": "+44 (000) 111 111 111"
}

Properties

Name	Type	Required	Restrictions	Description
phone_type	string	false	none	none
phone_number	string	false	none	none

InviteStatus

{
  "status_name": "Pending",
  "total": 5
}

Properties

Name	Type	Required	Restrictions	Description
status_name	string	false	none	none
total	integer	false	none	none

TagDetail

{
  "id": 1,
  "created": "string",
  "tag_name": "string",
  "first_name": "string",
  "last_name": "string",
  "li_user_id": "string",
  "user_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
created	string	false	none	none
tag_name	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
li_user_id	string	false	none	none
user_id	string	false	none	none

TrackingLinkSummary

{
  "id": 1,
  "link": "string",
  "tracking_link_name": "string",
  "clicked": 1,
  "unclicked": 1,
  "total": 2
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
link	string	false	none	none
tracking_link_name	string	false	none	none
clicked	integer	false	none	none
unclicked	integer	false	none	none
total	integer	false	none	none

Invite

{
  "id": 1,
  "created": "string",
  "li_link": "string",
  "li_user_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "phone": [
    {
      "phone_type": "mobile",
      "phone_number": "+44 (000) 111 111 111"
    }
  ],
  "position": "string",
  "company": "string",
  "country": "string",
  "webhooks": [
    {
      "tag_name": "string",
      "webhook_url": "https://webhook.mymosttrusted.net?fid=1323",
      "created": "string",
      "http_response": 200
    }
  ],
  "tags": [
    {
      "id": 1,
      "tag_name": "string",
      "created": "string"
    }
  ],
  "status_name": "string",
  "updated": "string",
  "user_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
created	string	false	none	none
li_link	string	false	none	none
li_user_id	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	false	none	none
phone	[PhoneItem]	false	none	none
position	string	false	none	none
company	string	false	none	none
country	string	false	none	none
webhooks	[WebhookItem]	false	none	none
tags	[TagItem]	false	none	none
status_name	string	false	none	none
updated	string	false	none	none
user_id	string	false	none	none

TrackingLinkDetail

{
  "id": 1,
  "link": "string",
  "tracking_link_name": "string",
  "created": "string",
  "clicked": "string",
  "tracking_link": "string",
  "first_name": "string",
  "last_name": "string",
  "li_user_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
link	string	false	none	none
tracking_link_name	string	false	none	none
created	string	false	none	none
clicked	string	false	none	none
tracking_link	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
li_user_id	string	false	none	none

MMT API v1.0.0

Introduction

Authentication

Networks

Retrieve a list of networks you can access

Parameters

Responses

Tags

Get detailed tags list logged for the network with id {id}

Parameters

Responses

Get detailed tags list logged for the by user with linkedin id li_user_id

Parameters

Responses

Stats

Get Summary on Available tracking links and tags summary

Parameters

Responses

Get Summary on invites

Parameters

Responses

TrackingLink

Get detailed tracking link list logged for the network with id {id}

Parameters

Responses

Get detailed tracking link list logged for the network with id {id} by user with linkedin id li_user_id

Parameters

Responses

Users

Get a list of available users

Parameters

Responses

Webhook

Get the current webhook configurations for user

Parameters

Responses

Configure webhook for a user

Parameters

Responses

Update webhook for a user

Parameters

Responses

Delete webhook for a user

Parameters

Responses

Config

Get the current search url and messages configurations for user

Parameters

Responses

Configure search url and messages for a user

Parameters

Responses

Invites

Get summarised invites listed in network

Parameters

Responses

Get contacts listed by specific user

Parameters

Responses

Connect

Get summarised to connect contacts listed in network

Parameters

Responses

Get to connect contacts listed by specific user

Parameters

Responses

Thumbnail

Get photo for the user_id specified by thumb_id

Parameters

Responses

Schemas

Network

Properties

OkResult

Properties

ConfigResult

Properties

WebhookResultItem

Properties

WebhookArray