Introduction

Welcome to the Webwalker API. You can use this API to access Webwalker API endpoints to get or push data to your account, manage the workflows, initiate social media actions, and more.

We have language bindings in Shell, PHP, Python, and JavaScript. 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 more information or have any questions, contact us via email or submit a form at our main website.

Keep in mind that Basic Plan doesn't include API access - you need to have Regular Plan or Premium Plan in order to access the Webwalker API.

Authentication

To authorize, use this code:

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/status',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/status", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/status" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/status',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Make sure to replace TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo with your API key.

Webwalker API requires API key in order to access the endpoints. You can get a new Webwalker API key at Integrations page in the app.

You can create a new integration with a separate API key for each 3rd party system or app that you want to connect to your account.

Webwalker expects for the API key to be included in all API requests to the server in a header that looks like the following:

api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo

You must replace TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo with your API key.

Errors

The Webwalker API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong or missing.
403	Forbidden -- Access to the endpoint or entry is restricted.
404	Not Found -- The specified entry or endpoint could not be found.
405	Method Not Allowed -- You tried to access an endpoint with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
429	Too Many Requests -- You're sending too many requests.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Versions

Webwalker uses versioning to improve our API without affecting existing integrations.

When we need to introduce a backwards-incompatible change (such as renaming or splitting a field) we will create a new version which users can migrate to when ready.

Core - Integration

Get status

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/status',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/status", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/status" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/status',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": {
    "id": 1,
    "account_id": 1,
    "label": "Integration Name"
  },
  "message": "Status loaded."
}

This endpoint retrieves the status of the current integration.

HTTP Request

GET http://core.webwalker.io/api/integration/1.0/status

Core - Users

Get All Users

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/users',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/users", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/users" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/users',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": [
    {
      "id": 1,
      "name": "Jane Doe",
      "email": "[email protected]"
    },
    {
      "id": 2,
      "name": "John Doe",
      "email": "[email protected]"
    },
  ],
  "links": {
    "first": "http://core.webwalker.io/api/integration/1.0/users?page=1",
    "last": "http://core.webwalker.io/api/integration/1.0/users?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/users?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http://core.webwalker.io/api/integration/1.0/users",
    "per_page": 10,
    "to": 2,
    "total": 2,
    "success": true,
    "message": "Users loaded."
  }
}

This endpoint retrieves all users in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/users

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of users per page to return (max 100).

Get a Specific User

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/users/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/users/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/users/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/users/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": {
    "id": 2,
    "name": "John Doe",
    "email": "[email protected]"
  },
  "meta": {
    "success": true,
    "message": "User found."
  }
}

This endpoint retrieves a specific user in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/users/<ID>

URL Parameters

Parameter	Description
ID	The ID of the user to retrieve.

Delete a Specific User

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/users/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/users/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/users/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/users/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": {
    "id": 2,
    "name": "John Doe",
    "email": "[email protected]"
  },
  "meta": {
    "success": true,
    "message": "User removed from the account."
  }
}

This endpoint deletes a specific user from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/users/<ID>

URL Parameters

Parameter	Description
ID	The ID of the user to delete.

Core - Schedules

Get All Schedules

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/schedules',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/schedules", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/schedules" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/schedules',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "name": "Default",
            "timezone": "America/New_York",
            "mon": 1,
            "mon_start": 540,
            "mon_end": 1020,
            "tue": 1,
            "tue_start": 540,
            "tue_end": 1020,
            "wed": 1,
            "wed_start": 540,
            "wed_end": 1020,
            "thu": 1,
            "thu_start": 540,
            "thu_end": 1020,
            "fri": 1,
            "fri_start": 540,
            "fri_end": 1020,
            "sat": 0,
            "sat_start": 540,
            "sat_end": 720,
            "sun": 0,
            "sun_start": 540,
            "sun_end": 720,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-05 08:18:21",
            "updated_at": "2022-08-08 00:59:35"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/schedules?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/schedules?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/schedules?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/schedules",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Schedules loaded."
    }
}

This endpoint retrieves all schedules in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/schedules

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of schedules per page to return (max 100).

Get a Specific Schedule

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/schedules/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/schedules/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/schedules/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/schedules/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "Default",
        "timezone": "America/New_York",
        "mon": 1,
        "mon_start": 540,
        "mon_end": 1020,
        "tue": 1,
        "tue_start": 540,
        "tue_end": 1020,
        "wed": 1,
        "wed_start": 540,
        "wed_end": 1020,
        "thu": 1,
        "thu_start": 540,
        "thu_end": 1020,
        "fri": 1,
        "fri_start": 540,
        "fri_end": 1020,
        "sat": 0,
        "sat_start": 540,
        "sat_end": 720,
        "sun": 0,
        "sun_start": 540,
        "sun_end": 720,
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-05 08:18:21",
        "updated_at": "2022-08-08 01:00:06"
    },
    "meta": {
        "success": true,
        "message": "Schedule found."
    }
}

This endpoint retrieves a specific schedule in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/schedules/<ID>

URL Parameters

Parameter	Description
ID	The ID of the schedule to retrieve.

Core - Workflows

Get All Workflows

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/workflows',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/workflows", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/workflows" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "name": "Connect US Sales Reps",
            "type": "contact",
            "spread": 1,
            "auto_enroll": 1,
            "reenroll": 0,
            "schedule_id": 1,
            "limit": {
                "list_add": 0,
                "list_remove": 0,
                "tag_add": 0,
                "tag_remove": 0,
                "note_add": 0,
                "note_remove": 0,
                "task_add": 0,
                "task_remove": 0,
                "workflow_enroll": 0,
                "workflow_pause": 0,
                "workflow_resume": 0,
                "linkedin": 200,
                "linkedin_view_profile": 100,
                "linkedin_follow_profile": 0,
                "linkedin_unfollow_profile": 0,
                "linkedin_endorse_profile": 0,
                "linkedin_like_post": 0,
                "linkedin_message_profile": 0,
                "linkedin_connect_profile": 50,
                "linkedin_withdraw_invitation": 0
            },
            "total_contacts_enrolled": 50,
            "total_contacts_finished": 38,
            "total_linkedin_viewed": 148,
            "total_linkedin": 349,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "paused_at": null,
            "created_at": "2022-02-22 08:27:20",
            "updated_at": "2022-03-18 06:05:18"
        },
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/workflows?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/workflows?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/workflows",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Workflows loaded."
    }
}

This endpoint retrieves all workflows in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/workflows

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of workflows per page to return (max 50).
query	NULL	Search query to filter workflows.

Get a Specific Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/workflows/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/workflows/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "Connect US Sales Reps",
        "type": "contact",
        "spread": 1,
        "auto_enroll": 1,
        "reenroll": 0,
        "schedule_id": 1,
        "limit": {
            "list_add": 0,
            "list_remove": 0,
            "tag_add": 0,
            "tag_remove": 0,
            "note_add": 0,
            "note_remove": 0,
            "task_add": 0,
            "task_remove": 0,
            "workflow_enroll": 0,
            "workflow_pause": 0,
            "workflow_resume": 0,
            "linkedin": 200,
            "linkedin_view_profile": 100,
            "linkedin_follow_profile": 0,
            "linkedin_unfollow_profile": 0,
            "linkedin_endorse_profile": 0,
            "linkedin_like_post": 0,
            "linkedin_message_profile": 0,
            "linkedin_connect_profile": 50,
            "linkedin_withdraw_invitation": 0
        },
        "total_contacts_enrolled": 50,
        "total_contacts_finished": 38,
        "total_linkedin_viewed": 148,
        "total_linkedin": 349,
        "today_processed_contacts": {
            "linkedin_view_profile": 7,
            "linkedin_like_post": 2,
            "linkedin_connect_profile": 5
        },
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "paused_at": null,
        "created_at": "2022-02-22 08:27:20",
        "updated_at": "2022-03-18 06:05:18"
    },
    "meta": {
        "success": true,
        "message": "Workflow found."
    }
}

This endpoint retrieves a specific workflow in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/workflows/<ID>

URL Parameters

Parameter	Description
ID	The ID of the workflow to retrieve.

Update a Specific Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/workflows/1',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'My Workflow',
      'schedule_id' => 23,
      'pause' => true,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "My Workflow",
    "schedule_id": 23,
    "pause": True
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/workflows/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"My Workflow\", \"schedule_id\": 23, \"pause\": true}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'My Workflow',
      'schedule_id': 23,
      'pause': true,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "Connect US Sales Reps",
        "type": "contact",
        "spread": 1,
        "auto_enroll": 1,
        "reenroll": 0,
        "schedule_id": 1,
        "limit": {
            "list_add": 0,
            "list_remove": 0,
            "tag_add": 0,
            "tag_remove": 0,
            "note_add": 0,
            "note_remove": 0,
            "task_add": 0,
            "task_remove": 0,
            "workflow_enroll": 0,
            "workflow_pause": 0,
            "workflow_resume": 0,
            "linkedin": 200,
            "linkedin_view_profile": 100,
            "linkedin_follow_profile": 0,
            "linkedin_unfollow_profile": 0,
            "linkedin_endorse_profile": 0,
            "linkedin_like_post": 0,
            "linkedin_message_profile": 0,
            "linkedin_connect_profile": 50,
            "linkedin_withdraw_invitation": 0
        },
        "total_contacts_enrolled": 50,
        "total_contacts_finished": 38,
        "total_linkedin_viewed": 148,
        "total_linkedin": 349,
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "paused_at": "2022-08-06 09:15:30",
        "created_at": "2022-02-22 08:27:20",
        "updated_at": "2022-03-18 06:05:18"
    },
    "meta": {
        "success": true,
        "message": "Workflow updated."
    }
}

This endpoint updates a specific workflow in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/workflows/<ID>

URL Parameters

Parameter	Description
ID	The ID of the workflow to update.

JSON Parameters

Parameter	Type	Description
name	string	Workflow name.
schedule_id	integer	ID of the schedule that should be used.
pause	boolean	Pause or resume workflow.

Delete a Specific Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/workflows/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/workflows/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "Connect US Sales Reps",
        "type": "contact",
        "spread": 1,
        "auto_enroll": 1,
        "reenroll": 0,
        "schedule_id": 1,
        "limit": {
            "list_add": 0,
            "list_remove": 0,
            "tag_add": 0,
            "tag_remove": 0,
            "note_add": 0,
            "note_remove": 0,
            "task_add": 0,
            "task_remove": 0,
            "workflow_enroll": 0,
            "workflow_pause": 0,
            "workflow_resume": 0,
            "linkedin": 200,
            "linkedin_view_profile": 100,
            "linkedin_follow_profile": 0,
            "linkedin_unfollow_profile": 0,
            "linkedin_endorse_profile": 0,
            "linkedin_like_post": 0,
            "linkedin_message_profile": 0,
            "linkedin_connect_profile": 50,
            "linkedin_withdraw_invitation": 0
        },
        "total_contacts_enrolled": 50,
        "total_contacts_finished": 38,
        "total_linkedin_viewed": 148,
        "total_linkedin": 349,
        "today_processed_contacts": {
            "linkedin_view_profile": 7,
            "linkedin_like_post": 2,
            "linkedin_connect_profile": 5
        },
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "paused_at": null,
        "created_at": "2022-02-22 08:27:20",
        "updated_at": "2022-03-18 06:05:18"
    },
    "meta": {
        "success": true,
        "message": "Workflow has been deleted."
    }
}

This endpoint deletes a specific workflow from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/workflows/<ID>

URL Parameters

Parameter	Description
ID	The ID of the workflow to delete.

Get Workflow Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/workflows/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "contact": {
                "id": 42,
                "first_name": "Angelica",
                "last_name": "Smith",
                "company": "Self Employed",
                "title": "Freelance Marketing and Advertising Consultant",
                "industry": "Internet",
                "city": "Los Angeles",
                "state": "California",
                "country": "United States",
                "email": null,
                "phone": null,
                "properties": [],
                "source": "linkedin",
                "source_type": "search",
                "source_origin": "1",
                "created_at": "2022-02-22 08:22:47",
                "updated_at": "2022-03-10 04:45:59"
            },
            "action_id": null,
            "details": {
                "linkedin_view_profile": "2022-02-22 08:38:30",
                "linkedin_like_post": "2022-03-03 08:28:59",
                "linkedin_follow_profile": "2022-03-08 06:26:22",
                "linkedin_connect_profile": "2022-03-09 05:57:50"
            },
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "processed_at": "2022-03-09 06:01:43",
            "paused_at": null,
            "finished_at": "2022-03-09 06:01:43",
            "created_at": "2022-02-22 08:34:30",
            "updated_at": "2022-03-09 06:01:43"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=5",
        "prev": null,
        "next": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts",
        "per_page": 10,
        "to": 10,
        "total": 50,
        "success": true,
        "message": "Workflow contacts loaded."
    }
}

This endpoint retrieves all contacts in the workflow.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/workflows/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the workflow to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Enroll Contact into Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts',
  [
    'headers' => $headers,
    'json' => [
      'contact_id' => 42,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "contact_id": 42
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/workflows/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"contact_id\": 42}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'contact_id': 42,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "workflow": {
            "id": 1,
            "name": "Connect US Sales Reps",
            "type": "contact",
            "spread": 1,
            "auto_enroll": 1,
            "reenroll": 0,
            "schedule_id": 1,
            "limit": {
                "list_add": 0,
                "list_remove": 0,
                "tag_add": 0,
                "tag_remove": 0,
                "note_add": 0,
                "note_remove": 0,
                "task_add": 0,
                "task_remove": 0,
                "workflow_enroll": 0,
                "workflow_pause": 0,
                "workflow_resume": 0,
                "linkedin": 200,
                "linkedin_view_profile": 100,
                "linkedin_follow_profile": 0,
                "linkedin_unfollow_profile": 0,
                "linkedin_endorse_profile": 0,
                "linkedin_like_post": 0,
                "linkedin_message_profile": 0,
                "linkedin_connect_profile": 50,
                "linkedin_withdraw_invitation": 0
            },
            "total_contacts_enrolled": 50,
            "total_contacts_finished": 38,
            "total_linkedin_viewed": 148,
            "total_linkedin": 349,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "paused_at": null,
            "created_at": "2022-02-22 08:27:20",
            "updated_at": "2022-03-18 06:05:18"
        },
        "contact": {
            "id": 42,
            "first_name": "Angelica",
            "last_name": "Smith",
            "company": "Self Employed",
            "title": "Freelance Marketing and Advertising Consultant",
            "industry": "Internet",
            "city": "Los Angeles",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:47",
            "updated_at": "2022-03-10 04:45:59"
        },
        "action_id": null,
        "details": {},
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "processed_at": null,
        "paused_at": null,
        "finished_at": null,
        "created_at": "2022-07-22 08:34:30",
        "updated_at": "2022-07-22 08:34:30",
    },
    "meta": {
        "success": true,
        "message": "Workflow contact added."
    }
}

This endpoint enrolls a contact into a workflow.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/workflows/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the workflow.

JSON Parameters

Parameter	Type	Description
contact_id	integer	ID of the contact to enroll.

Get a Specific Workflow Contact

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/workflows/1/contacts/42", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "workflow": {
            "id": 1,
            "name": "Connect US Sales Reps",
            "type": "contact",
            "spread": 1,
            "auto_enroll": 1,
            "reenroll": 0,
            "schedule_id": 1,
            "limit": {
                "list_add": 0,
                "list_remove": 0,
                "tag_add": 0,
                "tag_remove": 0,
                "note_add": 0,
                "note_remove": 0,
                "task_add": 0,
                "task_remove": 0,
                "workflow_enroll": 0,
                "workflow_pause": 0,
                "workflow_resume": 0,
                "linkedin": 200,
                "linkedin_view_profile": 100,
                "linkedin_follow_profile": 0,
                "linkedin_unfollow_profile": 0,
                "linkedin_endorse_profile": 0,
                "linkedin_like_post": 0,
                "linkedin_message_profile": 0,
                "linkedin_connect_profile": 50,
                "linkedin_withdraw_invitation": 0
            },
            "total_contacts_enrolled": 50,
            "total_contacts_finished": 38,
            "total_linkedin_viewed": 148,
            "total_linkedin": 349,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "paused_at": null,
            "created_at": "2022-02-22 08:27:20",
            "updated_at": "2022-03-18 06:05:18"
        },
        "contact": {
            "id": 42,
            "first_name": "Angelica",
            "last_name": "Smith",
            "company": "Self Employed",
            "title": "Freelance Marketing and Advertising Consultant",
            "industry": "Internet",
            "city": "Los Angeles",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:47",
            "updated_at": "2022-03-10 04:45:59"
        },
        "action_id": null,
        "details": {
            "linkedin_view_profile": "2022-02-22 08:38:30",
            "linkedin_like_post": "2022-03-03 08:28:59",
            "linkedin_follow_profile": "2022-03-08 06:26:22",
            "linkedin_connect_profile": "2022-03-09 05:57:50"
        },
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "processed_at": "2022-03-09 06:01:43",
        "paused_at": null,
        "finished_at": "2022-03-09 06:01:43",
        "created_at": "2022-02-22 08:34:30",
        "updated_at": "2022-03-09 06:01:43"
    },
    "meta": {
        "success": true,
        "message": "Workflow contact found."
    }
}

This endpoint retrieves a contact in the workflow.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/workflows/<WORKFLOW_ID>/contacts/<CONTACT_ID>

URL Parameters

Parameter	Description
WORKFLOW_ID	The ID of the workflow.
CONTACT_ID	The ID of the contact to retrieve.

Update a Contact in Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
  [
    'headers' => $headers,
    'json' => [
      'pause' => true,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "pause": True
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/workflows/1/contacts/42", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"pause\": true}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'pause': true,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "workflow": {
            "id": 1,
            "name": "Connect US Sales Reps",
            "type": "contact",
            "spread": 1,
            "auto_enroll": 1,
            "reenroll": 0,
            "schedule_id": 1,
            "limit": {
                "list_add": 0,
                "list_remove": 0,
                "tag_add": 0,
                "tag_remove": 0,
                "note_add": 0,
                "note_remove": 0,
                "task_add": 0,
                "task_remove": 0,
                "workflow_enroll": 0,
                "workflow_pause": 0,
                "workflow_resume": 0,
                "linkedin": 200,
                "linkedin_view_profile": 100,
                "linkedin_follow_profile": 0,
                "linkedin_unfollow_profile": 0,
                "linkedin_endorse_profile": 0,
                "linkedin_like_post": 0,
                "linkedin_message_profile": 0,
                "linkedin_connect_profile": 50,
                "linkedin_withdraw_invitation": 0
            },
            "total_contacts_enrolled": 50,
            "total_contacts_finished": 38,
            "total_linkedin_viewed": 148,
            "total_linkedin": 349,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "paused_at": null,
            "created_at": "2022-02-22 08:27:20",
            "updated_at": "2022-03-18 06:05:18"
        },
        "contact": {
            "id": 42,
            "first_name": "Angelica",
            "last_name": "Smith",
            "company": "Self Employed",
            "title": "Freelance Marketing and Advertising Consultant",
            "industry": "Internet",
            "city": "Los Angeles",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:47",
            "updated_at": "2022-03-10 04:45:59"
        },
        "action_id": null,
        "details": {
            "linkedin_view_profile": "2022-02-22 08:38:30",
            "linkedin_like_post": "2022-03-03 08:28:59",
            "linkedin_follow_profile": "2022-03-08 06:26:22",
            "linkedin_connect_profile": "2022-03-09 05:57:50"
        },
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "processed_at": "2022-03-09 06:01:43",
        "paused_at": "2022-07-09 07:05:45",
        "finished_at": "2022-03-09 06:01:43",
        "created_at": "2022-02-22 08:34:30",
        "updated_at": "2022-07-09 07:05:45"
    },
    "meta": {
        "success": true,
        "message": "Workflow contact updated."
    }
}

This endpoint updates a contact in the workflow.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/workflows/<WORKFLOW_ID>/contacts/<CONTACT_ID>

URL Parameters

Parameter	Description
WORKFLOW_ID	The ID of the workflow.
CONTACT_ID	The ID of the contact to update.

JSON Parameters

Parameter	Type	Description
pause	boolean	Pause or resume contact in the workflow.

Remove a Contact from Workflow

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/workflows/1/contacts/42", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/workflows/1/contacts/42',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "workflow": {
            "id": 1,
            "name": "Connect US Sales Reps",
            "type": "contact",
            "spread": 1,
            "auto_enroll": 1,
            "reenroll": 0,
            "schedule_id": 1,
            "limit": {
                "list_add": 0,
                "list_remove": 0,
                "tag_add": 0,
                "tag_remove": 0,
                "note_add": 0,
                "note_remove": 0,
                "task_add": 0,
                "task_remove": 0,
                "workflow_enroll": 0,
                "workflow_pause": 0,
                "workflow_resume": 0,
                "linkedin": 200,
                "linkedin_view_profile": 100,
                "linkedin_follow_profile": 0,
                "linkedin_unfollow_profile": 0,
                "linkedin_endorse_profile": 0,
                "linkedin_like_post": 0,
                "linkedin_message_profile": 0,
                "linkedin_connect_profile": 50,
                "linkedin_withdraw_invitation": 0
            },
            "total_contacts_enrolled": 50,
            "total_contacts_finished": 38,
            "total_linkedin_viewed": 148,
            "total_linkedin": 349,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "paused_at": null,
            "created_at": "2022-02-22 08:27:20",
            "updated_at": "2022-03-18 06:05:18"
        },
        "contact": {
            "id": 42,
            "first_name": "Angelica",
            "last_name": "Smith",
            "company": "Self Employed",
            "title": "Freelance Marketing and Advertising Consultant",
            "industry": "Internet",
            "city": "Los Angeles",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:47",
            "updated_at": "2022-03-10 04:45:59"
        },
        "action_id": null,
        "details": {
            "linkedin_view_profile": "2022-02-22 08:38:30",
            "linkedin_like_post": "2022-03-03 08:28:59",
            "linkedin_follow_profile": "2022-03-08 06:26:22",
            "linkedin_connect_profile": "2022-03-09 05:57:50"
        },
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "processed_at": "2022-03-09 06:01:43",
        "paused_at": null,
        "finished_at": "2022-03-09 06:01:43",
        "created_at": "2022-02-22 08:34:30",
        "updated_at": "2022-07-09 07:05:45"
    },
    "meta": {
        "success": true,
        "message": "Workflow contact has been deleted."
    }
}

This endpoint removes a contact from the workflow.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/workflows/<WORKFLOW_ID>/contacts/<CONTACT_ID>

URL Parameters

Parameter	Description
WORKFLOW_ID	The ID of the workflow.
CONTACT_ID	The ID of the contact to remove.

CRM - Contacts

Get All Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 975,
            "first_name": "Mary",
            "last_name": "Smith",
            "company": null,
            "title": null,
            "industry": null,
            "city": null,
            "state": null,
            "country": null,
            "email": null,
            "phone": null,
            "properties": [
                {
                    "id": 3,
                    "name": "my-custom-field",
                    "type": "text",
                    "label": "Custom text",
                    "description": "My notes.",
                    "details": [],
                    "default": null,
                    "value": {
                        "value": "A test contact created via API.",
                        "source": "api",
                        "source_type": "integration",
                        "source_origin": "1",
                        "created_at": "2022-07-21 11:51:36",
                        "updated_at": "2022-07-21 11:51:36"
                    },
                    "source": "manual",
                    "source_type": "user",
                    "source_origin": "1",
                    "created_at": "2022-07-21 11:50:16",
                    "updated_at": "2022-07-21 11:50:16"
                }
            ],
            "source": "api",
            "source_type": "integration",
            "source_origin": "1",
            "created_at": "2022-07-21 11:51:36",
            "updated_at": "2022-07-21 11:51:36"
        },
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/contacts?page=98",
        "prev": null,
        "next": "https://core.webwalker.io/api/integration/1.0/contacts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 98,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=97",
                "label": "97",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=98",
                "label": "98",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contacts?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/contacts",
        "per_page": 10,
        "to": 10,
        "total": 974,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all contacts in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/contacts

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).

Create a New Contact

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/contacts',
  [
    'headers' => $headers,
    'json' => [
      'first_name' => 'Luke',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "first_name": "Luke"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"first_name\": \"Luke\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'first_name': 'Luke',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 977,
        "first_name": "Luke",
        "last_name": null,
        "company": null,
        "title": null,
        "industry": null,
        "city": null,
        "state": null,
        "country": null,
        "email": null,
        "phone": null,
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 01:57:26",
        "updated_at": "2022-08-08 01:57:26"
    },
    "meta": {
        "success": true,
        "message": "Contact created."
    }
}

This endpoint creates a new contact in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/contacts

JSON Parameters

Parameter	Type	Description
email	email	Primary email of the contact.
linkedin	string	Contact LinkedIn ID.
first_name	string	Contact first name.
last_name	string	Contact last name.
company	string	Main company of the contact.
title	string	Title of the contact.
industry	string	Main industry of the contact.
city	string	Contact location - city.
state	string	Contact location - state.
country	string	Contact location - country.
phone	string	Primry phone number of the contact.
properties	object	Custom properties of the contact (e.g. `{"field1": "value", ... }`).

Get a Specific Contact

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/contacts/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/contacts/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/contacts/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contacts/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "first_name": "Mary",
        "last_name": "Smith",
        "company": null,
        "title": null,
        "industry": null,
        "city": null,
        "state": null,
        "country": null,
        "email": null,
        "phone": null,
        "properties": [
            {
                "id": 3,
                "name": "my-custom-field",
                "type": "text",
                "label": "Custom text",
                "description": "My notes.",
                "details": [],
                "default": null,
                "value": {
                    "value": "A test contact created via API.",
                    "source": "api",
                    "source_type": "integration",
                    "source_origin": "1",
                    "created_at": "2022-07-21 11:51:36",
                    "updated_at": "2022-07-21 11:51:36"
                },
                "source": "manual",
                "source_type": "user",
                "source_origin": "1",
                "created_at": "2022-07-21 11:50:16",
                "updated_at": "2022-07-21 11:50:16"
            }
        ],
        "companies": [],
        "positions": [],
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-07-21 11:51:36",
        "updated_at": "2022-07-21 11:51:36"
    },
    "meta": {
        "success": true,
        "message": "Contact found."
    }
}

This endpoint retrieves a specific contact in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/contacts/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact to retrieve.

Update a Specific Contact

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/contacts/1',
  [
    'headers' => $headers,
    'json' => [
      'first_name' => 'Lucia',
      'email' => '[email protected]',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "first_name": "Lucia",
    "email": "[email protected]"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/contacts/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/contacts/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"first_name\": \"Lucia\", \"email\": \"[email protected]\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contacts/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'first_name': 'Lucia',
      'email': '[email protected]',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "first_name": "Lucia",
        "last_name": null,
        "company": null,
        "title": null,
        "industry": null,
        "city": null,
        "state": null,
        "country": null,
        "email": "[email protected]",
        "phone": null,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 01:57:26",
        "updated_at": "2022-08-08 01:59:30"
    },
    "meta": {
        "success": true,
        "message": "Contact updated."
    }
}

This endpoint updates a specific contact in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/contacts/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact to update.

JSON Parameters

Parameter	Type	Description
email	email	Primary email of the contact.
linkedin	string	Contact LinkedIn ID.
first_name	string	Contact first name.
last_name	string	Contact last name.
company	string	Main company of the contact.
title	string	Title of the contact.
industry	string	Main industry of the contact.
city	string	Contact location - city.
state	string	Contact location - state.
country	string	Contact location - country.
phone	string	Primry phone number of the contact.
properties	object	Custom properties of the contact (e.g. `{"field1": "value", ... }`).

Delete a Specific Contact

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/contacts/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/contacts/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/contacts/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contacts/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "first_name": "Luke",
        "last_name": null,
        "company": null,
        "title": null,
        "industry": null,
        "city": null,
        "state": null,
        "country": null,
        "email": null,
        "phone": null,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:01:58",
        "updated_at": "2022-08-08 02:02:11"
    },
    "meta": {
        "success": true,
        "message": "Contact has been deleted."
    }
}

This endpoint deletes a specific contact from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/contacts/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact to delete.

CRM - Companies

Get All Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/companies',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/companies',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 2462,
            "name": "Example Systems Inc",
            "tagline": "We deliver exceptional AI services & solutions to help clients meet their unique business objectives.",
            "description": "Example Systems provides organizations with scalable IT services and solutions to address critical gaps in their current workforce and augment workforce management strategies.",
            "type": "Privately Held",
            "founded": "2015-01-01",
            "industry": "Information Technology & Services",
            "employees": 8,
            "address": "1234 Test St",
            "city": "Fremont",
            "state": "California",
            "country": "US",
            "postcode": "94538",
            "domain": "example.com",
            "website": "http://www.example.com",
            "phone": null,
            "source": "linkedin",
            "source_type": "suggestion",
            "source_origin": "3",
            "created_at": "2022-07-20 05:33:48",
            "updated_at": "2022-07-20 05:33:48"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/companies?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/companies?page=248",
        "prev": null,
        "next": "https://core.webwalker.io/api/integration/1.0/companies?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 248,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=247",
                "label": "247",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=248",
                "label": "248",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/companies?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/companies",
        "per_page": 10,
        "to": 10,
        "total": 2471,
        "success": true,
        "message": "Companies loaded."
    }
}

This endpoint retrieves all companies in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/companies

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of companies per page to return (max 100).

Create a New Company

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/companies',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'My Company',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "My Company"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"My Company\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/companies',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'My Company',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 2472,
        "name": "My Company",
        "tagline": null,
        "description": null,
        "type": null,
        "founded": null,
        "industry": null,
        "employees": null,
        "address": null,
        "city": null,
        "state": null,
        "country": null,
        "postcode": null,
        "domain": null,
        "website": null,
        "phone": null,
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 02:18:55",
        "updated_at": "2022-08-08 02:18:55"
    },
    "meta": {
        "success": true,
        "message": "Company created."
    }
}

This endpoint creates a new company in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/companies

JSON Parameters

Parameter	Type	Description
domain	string	Main domain of the company.
website	string	Company website URL.
linkedin	string	Company LinkedIn ID.
name	string	Company name.
tagline	string	Company tagline.
description	string	Description of the company.
type	string	Company type (public, nonprofit, private, etc).
founded	date	Company foundation date.
industry	string	Industry of the company.
employees	integer	Employees (the exact number).
employees_from	integer	Employees (from).
employees_to	integer	Employees (up to).
address	string	Company location - address.
city	string	Company location - city.
state	string	Company location - state.
country	string	Company location - country.
postcode	string	Company location - zip code.
phone	string	Main phone number of the company.

Get a Specific Company

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/companies/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/companies/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/companies/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/companies/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 2462,
        "name": "Example Systems Inc",
        "tagline": "We deliver exceptional AI services & solutions to help clients meet their unique business objectives.",
        "description": "Example Systems provides organizations with scalable IT services and solutions to address critical gaps in their current workforce and augment workforce management strategies.",
        "type": "Privately Held",
        "founded": "2015-01-01",
        "industry": "Information Technology & Services",
        "employees": 8,
        "address": "1234 Test St",
        "city": "Fremont",
        "state": "California",
        "country": "US",
        "postcode": "94538",
        "domain": "example.com",
        "website": "http://www.example.com",
        "phone": null,
        "source": "linkedin",
        "source_type": "suggestion",
        "source_origin": "3",
        "created_at": "2022-07-20 05:33:48",
        "updated_at": "2022-07-20 05:33:48"
    },
    "meta": {
        "success": true,
        "message": "Company found."
    }
}

This endpoint retrieves a specific company in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/companies/<ID>

URL Parameters

Parameter	Description
ID	The ID of the company to retrieve.

Update a Specific Company

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/companies/1',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'My Company',
      'phone' => '+1 555 123 456',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "My Company",
    "phone": "+1 555 123 456"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/companies/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/companies/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"My Company\", \"phone\": \"+1 555 123 456\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/companies/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'My Company',
      'phone': '+1 555 123 456',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 2472,
        "name": "My Company",
        "tagline": null,
        "description": null,
        "type": null,
        "founded": null,
        "industry": null,
        "employees": null,
        "address": null,
        "city": null,
        "state": null,
        "country": null,
        "postcode": null,
        "domain": null,
        "website": null,
        "phone": "+1 555 123 456",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:18:55",
        "updated_at": "2022-08-08 02:22:34"
    },
    "meta": {
        "success": true,
        "message": "Company updated."
    }
}

This endpoint updates a specific company in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/companies/<ID>

URL Parameters

Parameter	Description
ID	The ID of the company to update.

JSON Parameters

Parameter	Type	Description
domain	string	Main domain of the company.
website	string	Company website URL.
linkedin	string	Company LinkedIn ID.
name	string	Company name.
tagline	string	Company tagline.
description	string	Description of the company.
type	string	Company type (public, nonprofit, private, etc).
founded	date	Company foundation date.
industry	string	Industry of the company.
employees	integer	Employees (the exact number).
employees_from	integer	Employees (from).
employees_to	integer	Employees (up to).
address	string	Company location - address.
city	string	Company location - city.
state	string	Company location - state.
country	string	Company location - country.
postcode	string	Company location - zip code.
phone	string	Main phone number of the company.

Delete a Specific Company

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/companies/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/companies/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/companies/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/companies/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 2472,
        "name": "My Company",
        "tagline": null,
        "description": null,
        "type": null,
        "founded": null,
        "industry": null,
        "employees": null,
        "address": null,
        "city": null,
        "state": null,
        "country": null,
        "postcode": null,
        "domain": null,
        "website": null,
        "phone": "+1 555 123 456",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:18:55",
        "updated_at": "2022-08-08 02:22:55"
    },
    "meta": {
        "success": true,
        "message": "Company has been deleted."
    }
}

This endpoint deletes a specific company from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/companies/<ID>

URL Parameters

Parameter	Description
ID	The ID of the company to delete.

CRM - Contact Lists

Get All Contact Lists

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/contact-lists',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/contact-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 2,
            "name": "Import Test 1",
            "source": "import",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-03-14 05:44:43",
            "updated_at": "2022-03-14 05:44:43"
        },
        {
            "id": 1,
            "name": "Sales Reps US",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-02-24 04:33:15",
            "updated_at": "2022-02-24 04:33:15"
        },
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/contact-lists?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/contact-lists?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/contact-lists",
        "per_page": 10,
        "to": 5,
        "total": 5,
        "success": true,
        "message": "Contact lists loaded."
    }
}

This endpoint retrieves all contact lists in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/contact-lists

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contact lists per page to return (max 100).
query	NULL	Search query to filter contact lists.

Create a New Contact List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/contact-lists',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'my contact list',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "my contact list"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/contact-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"my contact list\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'my contact list',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my contact list",
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 02:32:28",
        "updated_at": "2022-08-08 02:32:28"
    },
    "meta": {
        "success": true,
        "message": "Contact list created."
    }
}

This endpoint creates a new contact list in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/contact-lists

JSON Parameters

Parameter	Type	Description
name	string	Contact list name.

Get a Specific Contact List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/contact-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 4,
        "name": "Sales Reps US",
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-02-24 04:33:15",
        "updated_at": "2022-02-24 04:33:15"
    },
    "meta": {
        "success": true,
        "message": "Contact list found."
    }
}

This endpoint retrieves a specific contact list in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/contact-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact list to retrieve.

Update a Specific Contact List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'My Contact List',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "My Contact List"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/contact-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"My Contact List\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'My Contact List',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "My Contact List",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:32:28",
        "updated_at": "2022-08-08 02:34:02"
    },
    "meta": {
        "success": true,
        "message": "Contact list updated."
    }
}

This endpoint updates a specific contact list in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/contact-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact list to update.

JSON Parameters

Parameter	Type	Description
name	string	Contact list name.

Delete a Specific Contact List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/contact-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "My Contact List",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:32:28",
        "updated_at": "2022-08-08 02:34:23"
    },
    "meta": {
        "success": true,
        "message": "Contact list has been deleted."
    }
}

This endpoint deletes a specific contact list from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/contact-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the contact list to delete.

Get Contact List Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/contact-lists/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 653,
            "first_name": "Alice",
            "last_name": "Williams",
            "company": null,
            "title": null,
            "industry": "Graphic Design",
            "city": "Los Angeles",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "properties": [],
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:45",
            "updated_at": "2022-02-22 08:22:45"
        },
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=5",
        "prev": null,
        "next": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/contact-lists/4/contacts",
        "per_page": 10,
        "to": 10,
        "total": 50,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all contacts in the contact list.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/contact-lists/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the contact list to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Add or Remove Contact List Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/contact-lists/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/contact-lists/1/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 9,
        "name": "my contact list 2",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 02:40:10",
        "updated_at": "2022-08-08 02:40:10"
    },
    "meta": {
        "success": true,
        "message": "Contact list updated."
    }
}

This endpoint adds or removes contacts to\from a specific contact list.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/contact-lists/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the contact list to update.

JSON Parameters

Parameter	Type	Description
add	array	Contacts to add to the contact list (array of contact ids).
remove	array	Contacts to remove from the contact list (array of contact ids).

CRM - Notes

Get All Notes

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/notes',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/notes", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/notes" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "name": "a-test-note-1",
            "label": "A test note 1",
            "content": "My test note.",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-23 06:02:45",
            "updated_at": "2022-01-23 06:02:45"
        },
        {
            "id": 2,
            "name": "another-test",
            "label": "Another test",
            "content": "Another test note.",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-23 06:02:59",
            "updated_at": "2022-01-23 06:02:59"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/notes?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/notes?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/notes?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/notes",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "Notes loaded."
    }
}

This endpoint retrieves all notes in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/notes

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of notes per page to return (max 100).
query	NULL	Search query to filter notes.

Create a New Note

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/notes',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'my-note',
      'label' => 'My Note',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "my-note",
    "label": "My Note"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/notes", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/notes" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"my-note\", \"label\": \"My Note\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'my-note',
      'label': 'My Note',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 4,
        "name": "my-note",
        "label": "My Note",
        "content": null,
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 03:16:24",
        "updated_at": "2022-08-08 03:16:24"
    },
    "meta": {
        "success": true,
        "message": "Note created."
    }
}

This endpoint creates a new note in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/notes

JSON Parameters

Parameter	Type	Description
name	string	Note name.
label	string	Note label.
content	string	Content of the note.

Get a Specific Note

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/notes/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/notes/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 4,
        "name": "my-note",
        "label": "My Note",
        "content": "This is my note.",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:16:24",
        "updated_at": "2022-08-08 03:16:24"
    },
    "meta": {
        "success": true,
        "message": "Note found."
    }
}

This endpoint retrieves a specific note in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/notes/<ID>

URL Parameters

Parameter	Description
ID	The ID of the note to retrieve.

Update a Specific Note

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/notes/1',
  [
    'headers' => $headers,
    'json' => [
      'label' => 'My Note',
      'content' => 'This is my test note',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "label": "My Note",
    "content": "This is my test note"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/notes/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"label\": \"My Note\", \"content\": \"This is my test note\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'label': 'My Note',
      'content': 'This is my test note',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 4,
        "name": "my-note",
        "label": "My Note",
        "content": "This is my test note",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:16:24",
        "updated_at": "2022-08-08 03:17:36"
    },
    "meta": {
        "success": true,
        "message": "Note updated."
    }
}

This endpoint updates a specific note in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/notes/<ID>

URL Parameters

Parameter	Description
ID	The ID of the note to update.

JSON Parameters

Parameter	Type	Description
name	string	Note name.
label	string	Note label.
content	string	Content of the note.

Delete a Specific Note

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/notes/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/notes/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 4,
        "name": "my-note",
        "label": "My Note",
        "content": "This is my test note",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:16:24",
        "updated_at": "2022-08-08 03:17:53"
    },
    "meta": {
        "success": true,
        "message": "Note has been deleted."
    }
}

This endpoint deletes a specific note from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/notes/<ID>

URL Parameters

Parameter	Description
ID	The ID of the note to delete.

Get Note Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/notes/1/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/notes/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "first_name": "Brandon",
            "last_name": "Smith",
            "company": "Example LLC",
            "title": "Sales Manager",
            "industry": "Information Technology & Services",
            "city": "Santa Monica",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "properties": [],
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:39",
            "updated_at": "2022-03-07 06:18:49"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/notes/1/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/notes/1/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/notes/1/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/notes/1/contacts",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all contacts in the note.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/notes/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the note to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Add or Remove Note Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/notes/1/contacts',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/notes/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "a-test-note-1",
        "label": "A test note 1",
        "content": "My test note.",
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-23 06:02:45",
        "updated_at": "2022-01-23 06:02:45"
    },
    "meta": {
        "success": true,
        "message": "Note contacts updated."
    }
}

This endpoint adds or removes contacts to\from a specific note.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/notes/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the note to update.

JSON Parameters

Parameter	Type	Description
add	array	Contacts to add to the note (array of contact ids).
remove	array	Contacts to remove from the note (array of contact ids).

Get Note Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/notes/1/companies',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/notes/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1/companies',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "name": "Example LLC",
            "tagline": "The Global Leader in Examples On-Demand",
            "description": "Example LLC is the global leader in Examples on-demand. We connect investment and business leaders with a dynamic network of examples.",
            "type": "Privately Held",
            "founded": "2008-01-01",
            "industry": "Information Services",
            "employees": 2395,
            "address": "123 Test St",
            "city": "London",
            "state": "England",
            "country": "GB",
            "postcode": "EC4V 3DX",
            "domain": "example.com",
            "website": "http://www.example.com",
            "phone": null,
            "source": "linkedin",
            "source_type": "conversation",
            "source_origin": "4",
            "created_at": "2022-01-25 08:33:06",
            "updated_at": "2022-01-25 08:33:06"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/notes/1/companies?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/notes/1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/notes/1/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/notes/1/companies",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Companies loaded."
    }
}

This endpoint retrieves all companies in the note.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/notes/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the note to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of companies per page to return (max 100).
query	NULL	Search query to filter companies.

Add or Remove Note Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/notes/1/companies',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/notes/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/notes/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/notes/1/companies',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "a-test-note-1",
        "label": "A test note 1",
        "content": "My test note.",
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-23 06:02:45",
        "updated_at": "2022-01-23 06:02:45"
    },
    "meta": {
        "success": true,
        "message": "Note companies updated."
    }
}

This endpoint adds or removes companies to\from a specific note.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/notes/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the note to update.

JSON Parameters

Parameter	Type	Description
add	array	Companies to add to the note (array of company ids).
remove	array	Companies to remove from the note (array of company ids).

CRM - Tags

Get All Tags

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "name": "my-leads",
            "label": "My Leads",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-20 07:47:53",
            "updated_at": "2022-01-20 07:47:53"
        },
        {
            "id": 2,
            "name": "usa",
            "label": "United States",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-20 07:48:23",
            "updated_at": "2022-01-20 07:48:23"
        },
        {
            "id": 3,
            "name": "my-accounts",
            "label": "My Accounts",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-03-11 04:16:29",
            "updated_at": "2022-03-11 04:16:29"
        },
        {
            "id": 5,
            "name": "test-b",
            "label": "test-b",
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-07-17 05:10:26",
            "updated_at": "2022-07-17 05:10:26"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tags?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tags?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tags?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tags",
        "per_page": 10,
        "to": 4,
        "total": 4,
        "success": true,
        "message": "Tags loaded."
    }
}

This endpoint retrieves all tags in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of tags per page to return (max 100).
query	NULL	Search query to filter tags.

Create a New Tag

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tags',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'my-tag',
      'label' => 'My Tag',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "my-tag",
    "label": "My Tag"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tags", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tags" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"my-tag\", \"label\": \"My Tag\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'my-tag',
      'label': 'My Tag',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-tag",
        "label": "My Tag",
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 03:24:20",
        "updated_at": "2022-08-08 03:24:20"
    },
    "meta": {
        "success": true,
        "message": "Tag created."
    }
}

This endpoint creates a new tag in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tags

JSON Parameters

Parameter	Type	Description
name	string	Tag name.
label	string	Tag label.

Get a Specific Tag

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-tag",
        "label": "My Tag",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:24:20",
        "updated_at": "2022-08-08 03:24:20"
    },
    "meta": {
        "success": true,
        "message": "Tag found."
    }
}

This endpoint retrieves a specific tag in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags/<ID>

URL Parameters

Parameter	Description
ID	The ID of the tag to retrieve.

Update a Specific Tag

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/tags/1',
  [
    'headers' => $headers,
    'json' => [
      'label' => 'My Tag',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "label": "My Tag"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/tags/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"label\": \"My Tag\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'label': 'My Tag',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-tag",
        "label": "My Tag",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:24:20",
        "updated_at": "2022-08-08 03:24:20"
    },
    "meta": {
        "success": true,
        "message": "Tag updated."
    }
}

This endpoint updates a specific tag in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/tags/<ID>

URL Parameters

Parameter	Description
ID	The ID of the tag to update.

JSON Parameters

Parameter	Type	Description
name	string	Tag name.
label	string	Tag label.

Delete a Specific Tag

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/tags/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/tags/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 7,
        "name": "test-123",
        "label": "Test 123",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:25:55",
        "updated_at": "2022-08-08 03:26:02"
    },
    "meta": {
        "success": true,
        "message": "Tag has been deleted."
    }
}

This endpoint deletes a specific tag from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/tags/<ID>

URL Parameters

Parameter	Description
ID	The ID of the tag to delete.

Get Tagged Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "first_name": "Brandon",
            "last_name": "Smith",
            "company": "Example LLC",
            "title": "Sales Manager",
            "industry": "Information Technology & Services",
            "city": "Santa Monica",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "properties": [],
            "tags": [
              "tag-abc",
              "my-test-tag"
            ],
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:39",
            "updated_at": "2022-03-07 06:18:49"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tags/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tags/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tags/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tags/contacts",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all tagged contacts (contacts that have at least one tag).

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags/contacts

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Get Tag Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags/1/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "first_name": "Brandon",
            "last_name": "Smith",
            "company": "Example LLC",
            "title": "Sales Manager",
            "industry": "Information Technology & Services",
            "city": "Santa Monica",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "properties": [],
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:39",
            "updated_at": "2022-03-07 06:18:49"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tags/1/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tags/1/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tags/1/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tags/1/contacts",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all contacts in the tag.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the tag to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Add or Remove Tag Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tags/1/contacts',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tags/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-tag",
        "label": "My Tag",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:24:20",
        "updated_at": "2022-08-08 03:24:20"
    },
    "meta": {
        "success": true,
        "message": "Tag contacts updated."
    }
}

This endpoint adds or removes contacts to\from a specific tag.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tags/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the tag to update.

JSON Parameters

Parameter	Type	Description
add	array	Contacts to add to the tag (array of contact ids).
remove	array	Contacts to remove from the tag (array of contact ids).

Get Tagged Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags/companies',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/companies',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "name": "Example LLC",
            "tagline": "The Global Leader in Examples On-Demand",
            "description": "Example LLC is the global leader in examples on-demand. We connect investment and business leaders with a dynamic network of examples.",
            "type": "Privately Held",
            "founded": "2008-01-01",
            "industry": "Information Services",
            "employees": 2395,
            "address": "123 Test St",
            "city": "London",
            "state": "England",
            "country": "GB",
            "postcode": "EC4V 3DX",
            "domain": "example.com",
            "website": "http://www.example.com",
            "phone": null,
            "tags": [
              "tag-abc",
              "my-test-tag"
            ],
            "source": "linkedin",
            "source_type": "conversation",
            "source_origin": "4",
            "created_at": "2022-01-25 08:33:06",
            "updated_at": "2022-01-25 08:33:06"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tags/companies?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tags/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tags/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tags/companies",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Companies loaded."
    }
}

This endpoint retrieves all tagged companies (companies that have at least one tag).

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags/companies

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of companies per page to return (max 100).
query	NULL	Search query to filter companies.

Get Tag Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tags/1/companies',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tags/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1/companies',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "name": "Example LLC",
            "tagline": "The Global Leader in Examples On-Demand",
            "description": "Example LLC is the global leader in examples on-demand. We connect investment and business leaders with a dynamic network of examples.",
            "type": "Privately Held",
            "founded": "2008-01-01",
            "industry": "Information Services",
            "employees": 2395,
            "address": "123 Test St",
            "city": "London",
            "state": "England",
            "country": "GB",
            "postcode": "EC4V 3DX",
            "domain": "example.com",
            "website": "http://www.example.com",
            "phone": null,
            "source": "linkedin",
            "source_type": "conversation",
            "source_origin": "4",
            "created_at": "2022-01-25 08:33:06",
            "updated_at": "2022-01-25 08:33:06"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tags/1/companies?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tags/1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tags/1/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tags/1/companies",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Companies loaded."
    }
}

This endpoint retrieves all companies in the tag.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tags/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the tag to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of companies per page to return (max 100).
query	NULL	Search query to filter companies.

Add or Remove Tag Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tags/1/companies',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tags/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tags/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tags/1/companies',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-tag",
        "label": "My Tag",
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:24:20",
        "updated_at": "2022-08-08 03:24:20"
    },
    "meta": {
        "success": true,
        "message": "Tag companies updated."
    }
}

This endpoint adds or removes companies to\from a specific tag.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tags/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the tag to update.

JSON Parameters

Parameter	Type	Description
add	array	Companies to add to the tag (array of company ids).
remove	array	Companies to remove from the tag (array of company ids).

CRM - Task Boards

Get All Task Boards

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/task-boards',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/task-boards", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "account_id": 1,
            "name": "My Team (Default)",
            "settings": {
                "default": true
            },
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-11-04 12:51:19",
            "updated_at": "2022-11-04 15:00:15"
        },
        {
            "id": 2,
            "account_id": 1,
            "name": "Api test",
            "settings": {
                "default": false
            },
            "source": "api",
            "source_type": "integration",
            "source_origin": "1",
            "created_at": "2022-11-12 16:55:17",
            "updated_at": "2022-11-12 16:58:42"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/task-boards?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/task-boards?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/task-boards?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/task-boards",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "Task boards loaded."
    }
}

This endpoint retrieves all task boards in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/task-boards

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of tasks per page to return (max 25).
query	NULL	Search query to filter tasks.

Create a New Task Board

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/task-boards',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'My Board',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "My Board"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/task-boards", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"My Board\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'My Board',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 7,
        "account_id": 1,
        "name": "My Board",
        "settings": {
            "default": false
        },
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-11-13 14:13:11",
        "updated_at": "2022-11-13 14:13:11"
    },
    "meta": {
        "success": true,
        "message": "Task board created."
    }
}

This endpoint creates a new task board in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/task-boards

JSON Parameters

Parameter	Type	Description
name	string	Task board name.

Get a Specific Task Board

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/task-boards/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/task-boards/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "account_id": 1,
        "name": "Api test",
        "settings": {
            "default": false
        },
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-12 16:55:17",
        "updated_at": "2022-11-12 16:58:42",
        "task_lists": [
            {
                "id": 24,
                "name": "List 1",
                "task_board_id": 6,
                "order": 1,
                "source": "api",
                "source_type": "integration",
                "source_origin": "1",
                "created_at": "2022-11-12 17:37:36",
                "updated_at": "2022-11-12 18:08:18",
                "tasks": [
                    {
                        "id": 23,
                        "account_id": 1,
                        "name": "task-1",
                        "label": "Task 1",
                        "description": "Just for testing",
                        "task_list_id": 24,
                        "source": "manual",
                        "source_type": "user",
                        "source_origin": "1",
                        "created_at": "2022-11-12 18:08:17",
                        "updated_at": "2022-11-12 18:08:17"
                    },
                    {
                        "id": 24,
                        "account_id": 1,
                        "name": "task-2",
                        "label": "Task 2",
                        "description": "Just for testing",
                        "task_list_id": 24,
                        "source": "api",
                        "source_type": "integration",
                        "source_origin": "1",
                        "created_at": "2022-11-13 13:44:18",
                        "updated_at": "2022-11-13 13:44:18"
                    }
                ]
            },
            {
                "id": 25,
                "name": "List 2",
                "task_board_id": 6,
                "order": 2,
                "source": "manual",
                "source_type": "user",
                "source_origin": "1",
                "created_at": "2022-11-12 18:08:40",
                "updated_at": "2022-11-12 18:08:40",
                "tasks": []
            }
        ],
        "max_task_list_order": 2
    },
    "meta": {
        "success": true,
        "message": "Task board found."
    }
}

This endpoint retrieves a specific task board in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/task-boards/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to retrieve.

Update a Specific Task Board

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/task-boards/6',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'Api task board',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "Api task board"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/task-boards/6", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards/6" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"Api task board\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards/6',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'Api task board',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "account_id": 1,
        "name": "Api task board",
        "settings": {
            "default": false
        },
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-12 16:55:17",
        "updated_at": "2022-11-13 14:19:48"
    },
    "meta": {
        "success": true,
        "message": "Task board updated."
    }
}

This endpoint updates a specific task board in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/task-boards/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
name	string	Task board name.

Delete a Specific Task Board

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/task-boards/7',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/task-boards/7", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards/7" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards/7',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 7,
        "account_id": 1,
        "name": "My Board",
        "settings": {
            "default": false
        },
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-13 14:13:11",
        "updated_at": "2022-11-13 14:25:25"
    },
    "meta": {
        "success": true,
        "message": "Task board has been deleted."
    }
}

This endpoint deletes a specific task board from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/task-boards/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task board to delete.

Get Task Lists

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/task-boards/6/task-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 24,
            "name": "List 1",
            "task_board_id": 6,
            "order": 1,
            "source": "api",
            "source_type": "integration",
            "source_origin": "1",
            "created_at": "2022-11-12 17:37:36",
            "updated_at": "2022-11-12 18:08:18",
            "tasks": [
                {
                    "id": 23,
                    "account_id": 1,
                    "name": "task-1",
                    "label": "Task 1",
                    "description": "Just for testing",
                    "task_list_id": 24,
                    "source": "manual",
                    "source_type": "user",
                    "source_origin": "1",
                    "created_at": "2022-11-12 18:08:17",
                    "updated_at": "2022-11-12 18:08:17"
                },
                {
                    "id": 24,
                    "account_id": 1,
                    "name": "task-2",
                    "label": "Task 2",
                    "description": "Just for testing",
                    "task_list_id": 24,
                    "source": "api",
                    "source_type": "integration",
                    "source_origin": "1",
                    "created_at": "2022-11-13 13:44:18",
                    "updated_at": "2022-11-13 13:44:18"
                }
            ]
        },
        {
            "id": 25,
            "name": "Col 2",
            "task_board_id": 6,
            "order": 2,
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-11-12 18:08:40",
            "updated_at": "2022-11-12 18:08:40",
            "tasks": []
        }
    ],
    "meta": {
        "success": true,
        "message": "Task lists loaded."
    }
}

This endpoint retrieves all Task lists in the task.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/task-boards/<ID>/task-lists

URL Parameters

Parameter	Description
ID	The ID of the task board to retrieve.

Query Parameters

Parameter	Default	Description
query	NULL	Search query to filter Task lists.

Create a New Task List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists',
  [
    'headers' => $headers,
    'json' => {
      'name': 'List 3'
  },
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "List 3"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/task-boards/6/task-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"List 3\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-boards/6/task-lists',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
        'name': 'List 3'
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 26,
        "name": "List 3",
        "task_board_id": 6,
        "order": 3,
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-11-13 14:34:00",
        "updated_at": "2022-11-13 14:34:00",
        "tasks": []
    },
    "meta": {
        "success": true,
        "message": "Task list created."
    }
}

This endpoint creates a Task list to a specific task board.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/task-boards/<ID>/task-lists

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
name	string	Task list name.

Get a Specific Task List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/task-lists/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/task-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/task-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-lists/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 24,
        "name": "List 1",
        "task_board_id": 6,
        "order": 1,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-12 17:37:36",
        "updated_at": "2022-11-12 18:08:18",
        "tasks": [
            {
                "id": 23,
                "account_id": 1,
                "name": "task-1",
                "label": "Task 1",
                "description": "Just for testing",
                "task_list_id": 24,
                "source": "manual",
                "source_type": "user",
                "source_origin": "1",
                "created_at": "2022-11-12 18:08:17",
                "updated_at": "2022-11-12 18:08:17"
            },
            {
                "id": 24,
                "account_id": 1,
                "name": "task-2",
                "label": "Task 2",
                "description": "Just for testing",
                "task_list_id": 24,
                "source": "api",
                "source_type": "integration",
                "source_origin": "1",
                "created_at": "2022-11-13 13:44:18",
                "updated_at": "2022-11-13 13:44:18"
            }
        ]
    },
    "meta": {
        "success": true,
        "message": "Task list found."
    }
}

This endpoint retrieves a specific task list in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/task-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task list to retrieve.

Update a Specific Task List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/task-lists/24',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'List 1!',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "List 1!"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/task-lists/24", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/task-lists/24" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"List 1!\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-lists/24',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'List 1!',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 24,
        "name": "List 1!",
        "task_board_id": 6,
        "order": 1,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-12 17:37:36",
        "updated_at": "2022-11-13 14:52:22",
        "tasks": [
            {
                "id": 23,
                "account_id": 1,
                "name": "task-1",
                "label": "Task 1",
                "description": "Just for testing",
                "task_list_id": 24,
                "source": "manual",
                "source_type": "user",
                "source_origin": "1",
                "created_at": "2022-11-12 18:08:17",
                "updated_at": "2022-11-12 18:08:17"
            },
            {
                "id": 24,
                "account_id": 1,
                "name": "task-2",
                "label": "Task 2",
                "description": "Just for testing",
                "task_list_id": 24,
                "source": "api",
                "source_type": "integration",
                "source_origin": "1",
                "created_at": "2022-11-13 13:44:18",
                "updated_at": "2022-11-13 13:44:18"
            }
        ]
    },
    "meta": {
        "success": true,
        "message": "Task list updated."
    }
}

This endpoint updates a specific task list in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/task-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
name	string	Task list name.

Delete a Specific Task List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/task-lists/26',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/task-lists/26", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/task-lists/26" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/task-lists/26',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 26,
        "name": "List 3",
        "task_board_id": 6,
        "order": 3,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-11-13 14:34:00",
        "updated_at": "2022-11-13 14:55:35",
        "tasks": []
    },
    "meta": {
        "success": true,
        "message": "Task list has been deleted."
    }
}

This endpoint deletes a specific task list from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/task-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task list to delete.

CRM - Tasks

Get All Tasks

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "name": "us-tx-sales",
            "label": "US tx Sales",
            "description": "Find leads in US TX region and make sales.",
            "task_list_id": 1,
            "todo_lists": [
                {
                    "id": 1,
                    "order": 0,
                    "label": "Prospect list",
                    "todos": [
                        {
                            "id": 1,
                            "order": 0,
                            "label": "Choose search filters and narrow down the search.",
                            "done": 1,
                            "created_at": "2022-01-20 09:08:24",
                            "updated_at": "2022-01-21 07:38:49"
                        },
                        {
                            "id": 2,
                            "order": 0,
                            "label": "Perform the search and load the results.",
                            "done": 1,
                            "created_at": "2022-01-20 09:08:36",
                            "updated_at": "2022-01-21 07:38:50"
                        },
                        {
                            "id": 3,
                            "order": 0,
                            "label": "Filter out the results and keep only the valid leads.",
                            "done": 0,
                            "created_at": "2022-01-20 09:09:04",
                            "updated_at": "2022-01-21 07:38:53"
                        }
                    ],
                    "created_at": "2022-01-20 09:08:00",
                    "updated_at": "2022-01-20 09:08:22"
                },
                {
                    "id": 2,
                    "order": 0,
                    "label": "Sales",
                    "todos": [
                        {
                            "id": 4,
                            "order": 0,
                            "label": "Plan out the sales approach.",
                            "done": 1,
                            "created_at": "2022-01-20 09:09:27",
                            "updated_at": "2022-01-21 07:38:54"
                        },
                        {
                            "id": 5,
                            "order": 0,
                            "label": "Setup a workflow to perform the sales automatically.",
                            "done": 0,
                            "created_at": "2022-01-20 09:09:37",
                            "updated_at": "2022-01-21 07:38:55"
                        }
                    ],
                    "created_at": "2022-01-20 09:09:14",
                    "updated_at": "2022-01-20 09:09:26"
                }
            ],
            "assigned_users": [],
            "source": "manual",
            "source_type": "user",
            "source_origin": "1",
            "created_at": "2022-01-20 09:07:34",
            "updated_at": "2022-01-20 09:07:34"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tasks?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tasks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tasks?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tasks",
        "per_page": 10,
        "to": 4,
        "total": 4,
        "success": true,
        "message": "Tasks loaded."
    }
}

This endpoint retrieves all tasks in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of tasks per page to return (max 25).
query	NULL	Search query to filter tasks.

Create a New Task

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tasks',
  [
    'headers' => $headers,
    'json' => [
      'name' => 'my-task',
      'label' => 'My Task',
      'task_list_id' => 1,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "name": "my-task",
    "label": "My Task",
    "task_list_id": 1
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tasks", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tasks" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"name\": \"my-task\", \"label\": \"My Task\", \"task_list_id\": 1}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'name': 'my-task',
      'label': 'My Task',
      'task_list_id': 1,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-task",
        "label": "My Task",
        "description": null,
        "task_list_id": 1,
        "source": "api",
        "source_type": "integration",
        "source_origin": 1,
        "created_at": "2022-08-08 03:38:40",
        "updated_at": "2022-08-08 03:38:40"
    },
    "meta": {
        "success": true,
        "message": "Task created."
    }
}

This endpoint creates a new task in the account.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tasks

JSON Parameters

Parameter	Type	Description
name	string	Task name.
label	string	Task label.
description	string	Description of the task.
task_list_id	integer	Task list id.

Get a Specific Task

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 3,
        "name": "us-tx-sales",
        "label": "US tx Sales",
        "description": "Find leads in US TX region and make sales.",
        "task_list_id": 1,
        "todo_lists": [
            {
                "id": 1,
                "order": 0,
                "label": "Prospect list",
                "todos": [
                    {
                        "id": 1,
                        "order": 0,
                        "label": "Choose search filters and narrow down the search.",
                        "done": 1,
                        "created_at": "2022-01-20 09:08:24",
                        "updated_at": "2022-01-21 07:38:49"
                    },
                    {
                        "id": 2,
                        "order": 0,
                        "label": "Perform the search and load the results.",
                        "done": 1,
                        "created_at": "2022-01-20 09:08:36",
                        "updated_at": "2022-01-21 07:38:50"
                    },
                    {
                        "id": 3,
                        "order": 0,
                        "label": "Filter out the results and keep only the valid leads.",
                        "done": 0,
                        "created_at": "2022-01-20 09:09:04",
                        "updated_at": "2022-01-21 07:38:53"
                    }
                ],
                "created_at": "2022-01-20 09:08:00",
                "updated_at": "2022-01-20 09:08:22"
            },
            {
                "id": 2,
                "order": 0,
                "label": "Sales",
                "todos": [
                    {
                        "id": 4,
                        "order": 0,
                        "label": "Plan out the sales approach.",
                        "done": 1,
                        "created_at": "2022-01-20 09:09:27",
                        "updated_at": "2022-01-21 07:38:54"
                    },
                    {
                        "id": 5,
                        "order": 0,
                        "label": "Setup a workflow to perform the sales automatically.",
                        "done": 0,
                        "created_at": "2022-01-20 09:09:37",
                        "updated_at": "2022-01-21 07:38:55"
                    }
                ],
                "created_at": "2022-01-20 09:09:14",
                "updated_at": "2022-01-20 09:09:26"
            }
        ],
        "assigned_users": [
            {
                "id": 1,
                "name": "Ruslan",
                "email": "[email protected]"
            }
        ],
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-24 06:50:20",
        "updated_at": "2022-01-24 06:50:20"
    },
    "meta": {
        "success": true,
        "message": "Task found."
    }
}

This endpoint retrieves a specific task in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to retrieve.

Update a Specific Task

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/tasks/1',
  [
    'headers' => $headers,
    'json' => [
      'label' => 'My Task',
      'description' => 'This is my test task',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "label": "My Task",
    "description": "This is my test task"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/tasks/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"label\": \"My Task\", \"description\": \"This is my test task\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'label': 'My Task',
      'description': 'This is my test task',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-task",
        "label": "My Task",
        "description": "This is my test task",
        "task_list_id": 1,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:38:40",
        "updated_at": "2022-08-08 03:42:15"
    },
    "meta": {
        "success": true,
        "message": "Task updated."
    }
}

This endpoint updates a specific task in the account.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/tasks/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
name	string	Task name.
label	string	Task label.
description	string	Description of the task.

Delete a Specific Task

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/tasks/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/tasks/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 6,
        "name": "my-task",
        "label": "My Task",
        "description": "This is my test task",
        "task_list_id": 1,
        "source": "api",
        "source_type": "integration",
        "source_origin": "1",
        "created_at": "2022-08-08 03:38:40",
        "updated_at": "2022-08-08 03:42:32"
    },
    "meta": {
        "success": true,
        "message": "Task has been deleted."
    }
}

This endpoint deletes a specific task from the account.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/tasks/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task to delete.

Get Task Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/contacts',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/contacts',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "first_name": "Brandon",
            "last_name": "Smith",
            "company": "Example LLC",
            "title": "Sales Manager",
            "industry": "Information Technology & Services",
            "city": "Santa Monica",
            "state": "California",
            "country": "United States",
            "email": null,
            "phone": null,
            "properties": [],
            "source": "linkedin",
            "source_type": "search",
            "source_origin": "1",
            "created_at": "2022-02-22 08:22:39",
            "updated_at": "2022-03-07 06:18:49"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Contacts loaded."
    }
}

This endpoint retrieves all contacts in the task.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the task to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of contacts per page to return (max 100).
query	NULL	Search query to filter contacts.

Add or Remove Task Contacts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/contacts',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tasks/1/contacts", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/contacts" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/contacts',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "us-tx-sales",
        "label": "US tx Sales",
        "description": "Find leads in US TX region and make sales.",
        "task_list_id": 1,
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-20 09:07:34",
        "updated_at": "2022-01-20 09:07:34"
    },
    "meta": {
        "success": true,
        "message": "Task contacts updated."
    }
}

This endpoint adds or removes contacts to\from a specific task.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tasks/<ID>/contacts

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
add	array	Contacts to add to the task (array of contact ids).
remove	array	Contacts to remove from the task (array of contact ids).

Get Task Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/companies',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/companies',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 649,
            "name": "Example LLC",
            "tagline": "The Global Leader in Examples On-Demand",
            "description": "Example LLC is the global leader in examples on-demand. We connect investment and business leaders with a dynamic network of examples.",
            "type": "Privately Held",
            "founded": "2008-01-01",
            "industry": "Information Services",
            "employees": 2395,
            "address": "123 Test St",
            "city": "London",
            "state": "England",
            "country": "GB",
            "postcode": "EC4V 3DX",
            "domain": "example.com",
            "website": "http://www.example.com",
            "phone": null,
            "source": "linkedin",
            "source_type": "conversation",
            "source_origin": "4",
            "created_at": "2022-01-25 08:33:06",
            "updated_at": "2022-01-25 08:33:06"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tasks/1/companies?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tasks/1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tasks/1/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tasks/1/companies",
        "per_page": 10,
        "to": 1,
        "total": 1,
        "success": true,
        "message": "Companies loaded."
    }
}

This endpoint retrieves all companies in the task.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the task to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of companies per page to return (max 100).
query	NULL	Search query to filter companies.

Add or Remove Task Companies

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/companies',
  [
    'headers' => $headers,
    'json' => [
      'add' => [1, 3],
      'remove' => [2, 4],
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "add": [1, 3],
    "remove": [2, 4]
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tasks/1/companies", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/companies" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"add\": [1, 3], \"remove\": [2, 4]}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/companies',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'add': [1, 3],
      'remove': [2, 4],
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "name": "us-tx-sales",
        "label": "US tx Sales",
        "description": "Find leads in US TX region and make sales.",
        "task_list_id": 1,
        "source": "manual",
        "source_type": "user",
        "source_origin": "1",
        "created_at": "2022-01-20 09:07:34",
        "updated_at": "2022-01-20 09:07:34"
    },
    "meta": {
        "success": true,
        "message": "Task companies updated."
    }
}

This endpoint adds or removes companies to\from a specific task.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tasks/<ID>/companies

URL Parameters

Parameter	Description
ID	The ID of the task to update.

JSON Parameters

Parameter	Type	Description
add	array	Companies to add to the task (array of company ids).
remove	array	Companies to remove from the task (array of company ids).

Get All Todo Lists

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks/1/todo-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
      {
          "id": 1,
          "order": 0,
          "label": "Prospect list",
          "todos": [
              {
                  "id": 1,
                  "order": 0,
                  "label": "Choose search filters and narrow down the search.",
                  "done": 1,
                  "created_at": "2022-01-20 09:08:24",
                  "updated_at": "2022-01-21 07:38:49"
              },
              {
                  "id": 2,
                  "order": 0,
                  "label": "Perform the search and load the results.",
                  "done": 1,
                  "created_at": "2022-01-20 09:08:36",
                  "updated_at": "2022-01-21 07:38:50"
              },
              {
                  "id": 3,
                  "order": 0,
                  "label": "Filter out the results and keep only the valid leads.",
                  "done": 0,
                  "created_at": "2022-01-20 09:09:04",
                  "updated_at": "2022-01-21 07:38:53"
              }
          ],
          "created_at": "2022-01-20 09:08:00",
          "updated_at": "2022-01-20 09:08:22"
      },
      {
          "id": 2,
          "order": 0,
          "label": "Sales",
          "todos": [
              {
                  "id": 4,
                  "order": 0,
                  "label": "Plan out the sales approach.",
                  "done": 1,
                  "created_at": "2022-01-20 09:09:27",
                  "updated_at": "2022-01-21 07:38:54"
              },
              {
                  "id": 5,
                  "order": 0,
                  "label": "Setup a workflow to perform the sales automatically.",
                  "done": 0,
                  "created_at": "2022-01-20 09:09:37",
                  "updated_at": "2022-01-21 07:38:55"
              }
          ],
          "created_at": "2022-01-20 09:09:14",
          "updated_at": "2022-01-20 09:09:26"
      }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "Todo lists loaded."
    }
}

This endpoint retrieves all todo lists in the task.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks/<ID>/todo-lists

URL Parameters

Parameter	Description
ID	The ID of the task.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of todo lists per page to return (max 50).
query	NULL	Search query to filter todo lists.

Create a New Todo List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists',
  [
    'headers' => $headers,
    'json' => [
      'order' => 3,
      'label' => 'My Todo List',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "order": 3,
    "label": "My Todo List"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tasks/1/todo-lists", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"order\": 3, \"label\": \"My Todo List\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/todo-lists',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'order': 3,
      'label': 'My Todo List',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 15,
        "order": 3,
        "label": "My Todo List",
        "created_at": "2022-08-08 03:50:14",
        "updated_at": "2022-08-08 03:50:14"
    },
    "meta": {
        "success": true,
        "message": "Todo list created."
    }
}

This endpoint creates a new todo list for the task.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tasks/<ID>/todo-lists

URL Parameters

Parameter	Description
ID	The ID of the task.

JSON Parameters

Parameter	Type	Description
order	integer	Todo list order.
label	string	Todo list label.

Get a Specific Todo List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/todo-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/todo-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "order": 0,
        "label": "Prospect list",
        "todos": [
            {
                "id": 1,
                "order": 0,
                "label": "Choose search filters and narrow down the search.",
                "done": 1,
                "created_at": "2022-01-20 09:08:24",
                "updated_at": "2022-01-21 07:38:49"
            },
            {
                "id": 2,
                "order": 0,
                "label": "Perform the search and load the results.",
                "done": 1,
                "created_at": "2022-01-20 09:08:36",
                "updated_at": "2022-01-21 07:38:50"
            },
            {
                "id": 3,
                "order": 0,
                "label": "Filter out the results and keep only the valid leads.",
                "done": 0,
                "created_at": "2022-01-20 09:09:04",
                "updated_at": "2022-01-21 07:38:53"
            }
        ],
        "created_at": "2022-01-20 09:08:00",
        "updated_at": "2022-01-20 09:08:22"
    },
    "meta": {
        "success": true,
        "message": "Todo list found."
    }
}

This endpoint retrieves a specific task in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/todo-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo list to retrieve.

Update a Specific Todo List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
  [
    'headers' => $headers,
    'json' => [
      'label' => 'My Checklist',
      'order' => 2,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "label": "My Checklist",
    "order": 2
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/todo-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/todo-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"label\": \"My Checklist\", \"order\": 2}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'label': 'My Checklist',
      'order': 2,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 15,
        "order": 2,
        "label": "My Checklist",
        "created_at": "2022-08-08 03:50:14",
        "updated_at": "2022-08-08 03:52:39"
    },
    "meta": {
        "success": true,
        "message": "Todo list updated."
    }
}

This endpoint updates a specific todo list.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/todo-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo list to update.

JSON Parameters

Parameter	Type	Description
order	integer	Todo list order.
label	string	Todo list label.

Delete a Specific Todo List

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/todo-lists/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/todo-lists/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todo-lists/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 15,
        "order": 2,
        "label": "My Checklist",
        "created_at": "2022-08-08 03:50:14",
        "updated_at": "2022-08-08 03:53:14"
    },
    "meta": {
        "success": true,
        "message": "Todo list has been deleted."
    }
}

This endpoint deletes a specific todo list.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/todo-lists/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo list to delete.

Get All Todo Items

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/todo-lists/1/todos", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "order": 0,
            "label": "Choose search filters and narrow down the search.",
            "done": 1,
            "created_at": "2022-01-20 09:08:24",
            "updated_at": "2022-01-21 07:38:49"
        },
        {
            "id": 2,
            "order": 0,
            "label": "Perform the search and load the results.",
            "done": 1,
            "created_at": "2022-01-20 09:08:36",
            "updated_at": "2022-01-21 07:38:50"
        },
        {
            "id": 3,
            "order": 0,
            "label": "Filter out the results and keep only the valid leads.",
            "done": 0,
            "created_at": "2022-01-20 09:09:04",
            "updated_at": "2022-01-21 07:38:53"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos",
        "per_page": 10,
        "to": 3,
        "total": 3,
        "success": true,
        "message": "Todos loaded."
    }
}

This endpoint retrieves all todo items in the todo list.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/todo-lists/<ID>/todos

URL Parameters

Parameter	Description
ID	The ID of the todo list.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of todo items per page to return (max 100).
query	NULL	Search query to filter todo items.

Create a New Todo Item

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos',
  [
    'headers' => $headers,
    'json' => [
      'order' => 3,
      'done' => false,
      'label' => 'My Todo Item',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "order": 3,
    "done": False,
    "label": "My Todo Item"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/todo-lists/1/todos", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"order\": 3, \"label\": \"My Todo Item\", \"done\": false}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todo-lists/1/todos',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'order': 3,
      'done': false,
      'label': 'My Todo Item',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 49,
        "order": 3,
        "label": "My Todo Item",
        "done": false,
        "created_at": "2022-08-08 03:56:17",
        "updated_at": "2022-08-08 03:56:17"
    },
    "meta": {
        "success": true,
        "message": "Todo created."
    }
}

This endpoint creates a new todo item for the todo list.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/todo-lists/<ID>/todos

URL Parameters

Parameter	Description
ID	The ID of the todo list.

JSON Parameters

Parameter	Type	Description
order	integer	Todo order.
label	string	Todo label.
done	boolean	Todo completion status.

Get a Specific Todo Item

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/todos/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/todos/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/todos/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todos/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 49,
        "order": 3,
        "label": "My Todo Item",
        "done": 0,
        "created_at": "2022-08-08 03:56:17",
        "updated_at": "2022-08-08 03:56:17"
    },
    "meta": {
        "success": true,
        "message": "Todo found."
    }
}

This endpoint retrieves a specific todo item in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/todos/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo item to retrieve.

Update a Specific Todo Item

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/todos/1',
  [
    'headers' => $headers,
    'json' => [
      'label' => 'My Todo',
      'order' => 2,
      'done' => true,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "label": "My Todo",
    "order": 2,
    "done": True
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/todos/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/todos/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"label\": \"My Todo\", \"order\": 2, \"done\": true}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todos/1',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'label': 'My Todo',
      'order': 2,
      'done': true,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 49,
        "order": 2,
        "label": "My Todo",
        "done": true,
        "created_at": "2022-08-08 03:56:17",
        "updated_at": "2022-08-08 03:57:16"
    },
    "meta": {
        "success": true,
        "message": "Todo updated."
    }
}

This endpoint updates a specific todo item.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/todos/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo item to update.

JSON Parameters

Parameter	Type	Description
order	integer	Todo order.
label	string	Todo label.
done	boolean	Todo completion status.

Delete a Specific Todo Item

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/todos/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/todos/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/todos/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/todos/1',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 49,
        "order": 2,
        "label": "My Todo",
        "done": 1,
        "created_at": "2022-08-08 03:56:17",
        "updated_at": "2022-08-08 03:57:35"
    },
    "meta": {
        "success": true,
        "message": "Todo has been deleted."
    }
}

This endpoint deletes a specific todo item.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/todos/<ID>

URL Parameters

Parameter	Description
ID	The ID of the todo item to delete.

Get All Task Comments

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/tasks/24/comments',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/tasks/24/comments", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/24/comments" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/24/comments',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 18,
            "task_id": 24,
            "user_id": 1,
            "user_name": "John Doe",
            "text": "Comment 1",
            "created_at": "2022-11-13 15:07:26",
            "updated_at": "2022-11-13 15:07:26"
        },
        {
            "id": 19,
            "task_id": 24,
            "user_id": 1,
            "user_name": "John Doe",
            "text": "Comment 2",
            "created_at": "2022-11-13 15:07:41",
            "updated_at": "2022-11-13 15:07:41"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/tasks/24/comments?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/tasks/24/comments?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/tasks/24/comments?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/tasks/24/comments",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "Task comments loaded."
    }
}

This endpoint retrieves all task comments in the task.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/tasks/<ID>/comments

URL Parameters

Parameter	Description
ID	The ID of the task.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of task comments per page to return (max 50).
query	NULL	Search query to filter task comments.

Create a New Task Comment

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/tasks/24/comments',
  [
    'headers' => $headers,
    'json' => [
      'text' => 'My Task Comment',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "text": "My Task Comment"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/tasks/24/comments", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/tasks/24/comments" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"text\": \"My Task Comment\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/tasks/1/comments',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'text': 'My Task Comment',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 20,
        "task_id": 24,
        "user_id": "1",
        "user_name": "John Doe",
        "text": "My Task Comment",
        "created_at": "2022-11-13 15:22:26",
        "updated_at": "2022-11-13 15:22:26"
    },
    "meta": {
        "success": true,
        "message": "Task comment created."
    }
}

This endpoint creates a new task comment for the task.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/tasks/<ID>/comments

URL Parameters

Parameter	Description
ID	The ID of the task.

JSON Parameters

Parameter	Type	Description
text	string	Task comment text.

Get a Specific Task Comment

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/comments/18',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/comments/18", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/comments/18" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/comments/18',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 18,
        "task_id": 24,
        "user_id": 1,
        "user_name": "John Doe",
        "text": "Comment 1",
        "created_at": "2022-11-13 15:07:26",
        "updated_at": "2022-11-13 15:07:26"
    },
    "meta": {
        "success": true,
        "message": "Task comment found."
    }
}

This endpoint retrieves a specific task comment in the account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/comments/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task comment to retrieve.

Update a Specific Task Comment

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'PATCH',
  'https://core.webwalker.io/api/integration/1.0/comments/18',
  [
    'headers' => $headers,
    'json' => [
      'text' => 'Done!',
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "text": "Done!"
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("PATCH", "/api/integration/1.0/comments/18", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request PATCH \
  --url "https://core.webwalker.io/api/integration/1.0/comments/18" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"text\": \"Done!\"}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/comments/18',
    method: 'patch',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'text': 'Done!',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 18,
        "task_id": 24,
        "user_id": 1,
        "user_name": "John Doe",
        "text": "Done!",
        "created_at": "2022-11-13 15:07:26",
        "updated_at": "2022-11-13 15:28:45"
    },
    "meta": {
        "success": true,
        "message": "Task comment updated."
    }
}

This endpoint updates a specific task comment.

HTTP Request

PATCH https://core.webwalker.io/api/integration/1.0/comments/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task comment to update.

JSON Parameters

Parameter	Type	Description
text	string	Task comment label.

Delete a Specific Task Comment

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'DELETE',
  'https://core.webwalker.io/api/integration/1.0/comments/20',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("DELETE", "/api/integration/1.0/comments/20", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request DELETE \
  --url "https://core.webwalker.io/api/integration/1.0/comments/20" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/comments/20',
    method: 'delete',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 20,
        "task_id": 24,
        "user_id": 1,
        "user_name": "John Doe",
        "text": "My Task Comment",
        "created_at": "2022-11-13 15:22:26",
        "updated_at": "2022-11-13 15:33:05"
    },
    "meta": {
        "success": true,
        "message": "Task comment has been deleted."
    }
}

This endpoint deletes a specific task comment.

HTTP Request

DELETE https://core.webwalker.io/api/integration/1.0/comments/<ID>

URL Parameters

Parameter	Description
ID	The ID of the task comment to delete.

LinkedIn - Accounts

Get All LinkedIn Accounts

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": [
    {
      "id": 4,
      "username": "[email protected]",
      "status": "paused",
      "schedule_id": 1,
      "settings": {
        "create_contact": {
          "account": true,
          "connection": true,
          "invitation": true,
          "suggestion": false,
          "view": true,
          "search": true,
          "group": true,
          "conversation": true
        },
        "create_company": {
          "account": true,
          "connection": true,
          "invitation": true,
          "suggestion": false,
          "view": true,
          "search": true,
          "group": true,
          "conversation": true
        },
        "simulate_human": true,
        "simulate_human_advanced": true,
        "paused": true
      }
    },
    {
      "id": 5,
      "username": "[email protected]",
      "status": "loading",
      "schedule_id": null,
      "settings": []
    },
  ],
  "links": {
    "first": "http://core.webwalker.io/api/integration/1.0/linkedin?page=1",
    "last": "http://core.webwalker.io/api/integration/1.0/linkedin?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/linkedin?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http://core.webwalker.io/api/integration/1.0/linkedin",
    "per_page": 10,
    "to": 4,
    "total": 4,
    "success": true,
    "message": "LinkedIn accounts loaded."
  }
}

This endpoint retrieves all LinkedIn accounts.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn accounts per page to return (max 100).

Get a Specific LinkedIn Account

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": {
    "id": 6,
    "username": "[email protected]",
    "status": "active",
    "profile": {
      "id": 12,
      "linkedin": "john-doe-120a45123",
      "email": null,
      "first_name": "John",
      "middle_name": null,
      "last_name": "Doe",
      "headline": null,
      "summary": null,
      "address": null,
      "birthday": null,
      "premium": false,
      "influencer": false
    },
    "schedule_id": 1,
    "settings": {
      "create_company": {
        "account": true,
        "connection": true,
        "invitation": true,
        "suggestion": true,
        "view": true,
        "conversation": true,
        "group": true,
        "search": true
      },
      "create_contact": {
        "account": true,
        "connection": true,
        "invitation": true,
        "suggestion": true,
        "view": true,
        "search": true,
        "group": true,
        "conversation": true
      },
      "simulate_human": true
    },
    "total_connections": 12,
    "total_invitations_sent": 2,
    "today_all_activity": 9,
    "today_actions_activity": 1,
    "today_view_profile_activity": 0,
    "today_follow_profile_activity": 0,
    "today_endorse_profile_activity": 0,
    "today_like_profile_activity": 0,
    "today_message_profile_activity": 0,
    "today_connect_profile_activity": 1,
    "today_withdraw_invitation_activity": 0
  },
  "meta": {
    "success": true,
    "message": "LinkedIn account found."
  }
}

This endpoint retrieves a specific LinkedIn account.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/<ID>

URL Parameters

Parameter	Description
ID	The ID of the LinkedIn account to retrieve.

LinkedIn - Connections

Get All LinkedIn Connections

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/connections',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/connections", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/connections" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/connections',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": [
    {
      "id": 1745,
      "linkedin_id": 3,
      "profile": {
        "id": 3,
        "linkedin": "mary-smith-12ba34567",
        "email": "[email protected]",
        "first_name": "Mary",
        "middle_name": null,
        "last_name": "Smith",
        "headline": "Front End Developer",
        "summary": "I am a full stack developer.",
        "address": null,
        "birthday": null,
        "premium": false,
        "influencer": false,
        "contact": {
          "id": 4,
          "first_name": "Mary",
          "last_name": "Smith",
          "company": "Self-Employed",
          "title": "Front End Developer",
          "industry": "Program Development",
          "city": "Philadelphia",
          "state": "Pennsylvania",
          "country": "United States",
          "email": "[email protected]",
          "phone": null,
          "source": "linkedin",
          "source_type": "connection",
          "source_origin": "3",
          "created_at": "2022-01-11 09:25:47",
          "updated_at": "2022-01-11 09:35:01"
        }
      },
      "connected_at": "2021-11-26 04:20:34"
    },
    {
      "id": 12,
      "linkedin_id": 3,
      "profile": {
        "id": 14,
        "linkedin": "carl-123456",
        "email": null,
        "first_name": "Carl",
        "middle_name": null,
        "last_name": "P.",
        "headline": "Front-end Developer",
        "summary": "I'm a Front-end developer dedicated to continuously learning more about creating fluent, semantic, and appealing websites.",
        "address": null,
        "birthday": null,
        "premium": false,
        "influencer": false,
        "contact": {
          "id": 15,
          "first_name": "Carl",
          "last_name": "P.",
          "company": null,
          "title": null,
          "industry": "Higher Education",
          "city": "Los Angeles",
          "state": "California",
          "country": "United States",
          "email": null,
          "phone": null,
          "source": "linkedin",
          "source_type": "invitation",
          "source_origin": "3",
          "created_at": "2022-01-11 09:27:01",
          "updated_at": "2022-01-11 09:27:01"
        }
      },
      "connected_at": "2022-01-11 09:30:14"
    }
  ],
  "links": {
    "first": "http://core.webwalker.io/api/integration/1.0/linkedin/connections?page=1",
    "last": "http://core.webwalker.io/api/integration/1.0/linkedin/connections?page=52",
    "prev": null,
    "next": "http://core.webwalker.io/api/integration/1.0/linkedin/connections?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 52,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/linkedin/connections?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/linkedin/connections?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http://core.webwalker.io/api/integration/1.0/linkedin/connections",
    "per_page": 10,
    "to": 10,
    "total": 514,
    "success": true,
    "message": "LinkedIn connections loaded."
  }
}

This endpoint retrieves all LinkedIn connections.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/connections

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn connections per page to return (max 100).
linkedin_id	null	LinkedIn account id (to return only connections of the specific LinkedIn account).

LinkedIn - Invitations

Get All LinkedIn Invitations

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/invitations',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPInvitation("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/invitations", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/invitations" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/invitations',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
  "data": [
    {
      "id": 1745,
      "linkedin_id": 3,
      "profile": {
        "id": 3,
        "linkedin": "mary-smith-12ba34567",
        "email": "[email protected]",
        "first_name": "Mary",
        "middle_name": null,
        "last_name": "Smith",
        "headline": "Front End Developer",
        "summary": "I am a full stack developer.",
        "address": null,
        "birthday": null,
        "premium": false,
        "influencer": false,
        "contact": {
          "id": 4,
          "first_name": "Mary",
          "last_name": "Smith",
          "company": "Self-Employed",
          "title": "Front End Developer",
          "industry": "Program Development",
          "city": "Philadelphia",
          "state": "Pennsylvania",
          "country": "United States",
          "email": "[email protected]",
          "phone": null,
          "source": "linkedin",
          "source_type": "invitation",
          "source_origin": "3",
          "created_at": "2022-01-11 09:25:47",
          "updated_at": "2022-01-11 09:35:01"
        }
      },
      "message": null,
      "sent": false,
      "sent_at": "2021-11-26 04:20:34"
    },
    {
      "id": 12,
      "linkedin_id": 3,
      "profile": {
        "id": 14,
        "linkedin": "carl-123456",
        "email": null,
        "first_name": "Carl",
        "middle_name": null,
        "last_name": "P.",
        "headline": "Front-end Developer",
        "summary": "I'm a Front-end developer dedicated to continuously learning more about creating fluent, semantic, and appealing websites.",
        "address": null,
        "birthday": null,
        "premium": false,
        "influencer": false,
        "contact": {
          "id": 15,
          "first_name": "Carl",
          "last_name": "P.",
          "company": null,
          "title": null,
          "industry": "Higher Education",
          "city": "Los Angeles",
          "state": "California",
          "country": "United States",
          "email": null,
          "phone": null,
          "source": "linkedin",
          "source_type": "invitation",
          "source_origin": "3",
          "created_at": "2022-01-11 09:27:01",
          "updated_at": "2022-01-11 09:27:01"
        }
      },
      "message": "Let's connect!",
      "sent": true,
      "sent_at": "2022-01-11 09:30:14"
    }
  ],
  "links": {
    "first": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations?page=1",
    "last": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations?page=52",
    "prev": null,
    "next": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 52,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http://core.webwalker.io/api/integration/1.0/linkedin/invitations",
    "per_page": 10,
    "to": 10,
    "total": 514,
    "success": true,
    "message": "LinkedIn invitations loaded."
  }
}

This endpoint retrieves all LinkedIn invitations.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/invitations

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn invitations per page to return (max 100).
linkedin_id	null	LinkedIn account id (to return only invitations of the specific LinkedIn account).

Invite Contact to Connect on LinkedIn

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'POST',
  'https://core.webwalker.io/api/integration/1.0/linkedin/1/invitations',
  [
    'headers' => $headers,
    'json' => [
      'contact_id' => 42,
    ],
  ]
);

$response = $request->getBody()->getContents();

import http.client
import json

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = json.dumps({
    "contact_id": 42
})

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo",
  "content-type": "application/json"
}

connection.request("POST", "/api/integration/1.0/linkedin/1/invitations", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request POST \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/1/invitations" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo" \
  --header "content-type: application/json" \
  --data "{\"contact_id\": 42}"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/1/invitations',
    method: 'post',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
      'content-type': 'application/json',
    },
    data: {
      'contact_id': 42,
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {},
    "meta": {
        "success": true,
        "message": "LinkedIn connection request queued."
    }
}

This endpoint invites contact to connect on LinkedIn.

HTTP Request

POST https://core.webwalker.io/api/integration/1.0/linkedin/<ID>/invitations

URL Parameters

Parameter	Description
ID	The ID of the LinkedIn account (the invitation will be sent using this account).

JSON Parameters

Parameter	Type	Description
contact_id	integer	ID of the contact that will be invited to connect.
linkedin	string	LinkedIn profile page URL of the contact that will be invited to connected.
message	string	Invitation message (optional).

LinkedIn - Conversations

Get All LinkedIn Conversations

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/conversations',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/conversations", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/conversations" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/conversations',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 1,
            "linkedin_id": 3,
            "participants": [
                {
                    "id": 4,
                    "linkedin": "john-doe-123",
                    "email": "[email protected]",
                    "first_name": "John",
                    "middle_name": null,
                    "last_name": "Doe",
                    "headline": "Marketing Manager",
                    "summary": "I'm a test contact.",
                    "address": null,
                    "birthday": null,
                    "premium": false,
                    "influencer": false,
                    "contact": {
                        "id": 5,
                        "first_name": "John",
                        "last_name": "Doe",
                        "company": "Example Inc.",
                        "title": "Marketing Manager",
                        "industry": "Computer Software",
                        "city": "Los Angeles",
                        "state": "California",
                        "country": "United States",
                        "email": "[email protected]",
                        "phone": null,
                        "source": "linkedin",
                        "source_type": "connection",
                        "source_origin": "3",
                        "created_at": "2022-01-11 09:25:51",
                        "updated_at": "2022-01-11 09:29:47"
                    }
                },
                {
                    "id": 1,
                    "linkedin": "jane-doe-4c1031123",
                    "email": null,
                    "first_name": "Jane",
                    "middle_name": null,
                    "last_name": "Doe",
                    "headline": null,
                    "summary": null,
                    "address": null,
                    "birthday": null,
                    "premium": false,
                    "influencer": false,
                    "contact": {
                        "id": 34,
                        "first_name": "Jane",
                        "last_name": "Doe",
                        "company": null,
                        "title": null,
                        "industry": null,
                        "city": null,
                        "state": null,
                        "country": null,
                        "email": null,
                        "phone": null,
                        "source": "linkedin",
                        "source_type": "conversation",
                        "source_origin": "3",
                        "created_at": "2022-01-11 09:31:07",
                        "updated_at": "2022-01-11 09:31:07"
                    }
                }
            ],
            "last_event": {
                "id": 24,
                "sent_by": 4,
                "inmail": false,
                "message": "A test message.",
                "attachments": null,
                "media": null,
                "reactions": null,
                "sent_at": "2021-05-28 07:35:47"
            },
            "name": null,
            "group": false,
            "read": true,
            "archived": false,
            "important": false,
            "unread_count": 2,
            "total_count": 2,
            "activity_at": "2021-05-28 07:35:47"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=32",
        "prev": null,
        "next": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 32,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=31",
                "label": "31",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=32",
                "label": "32",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations",
        "per_page": 10,
        "to": 10,
        "total": 311,
        "success": true,
        "message": "LinkedIn conversations loaded."
    }
}

This endpoint retrieves all LinkedIn conversations.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/conversations

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn conversations per page to return (max 50).
linkedin_id	null	LinkedIn account id (to return only conversations of the specific LinkedIn account).

Get a Specific LinkedIn Conversation

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/conversations/1", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": {
        "id": 1,
        "linkedin_id": 3,
        "participants": [
            {
                "id": 4,
                "linkedin": "john-doe-123",
                "email": "[email protected]",
                "first_name": "John",
                "middle_name": null,
                "last_name": "Doe",
                "headline": "Marketing Manager",
                "summary": "I'm a test contact.",
                "address": null,
                "birthday": null,
                "premium": false,
                "influencer": false,
                "contact": {
                    "id": 5,
                    "first_name": "John",
                    "last_name": "Doe",
                    "company": "Example Inc.",
                    "title": "Marketing Manager",
                    "industry": "Computer Software",
                    "city": "Los Angeles",
                    "state": "California",
                    "country": "United States",
                    "email": "[email protected]",
                    "phone": null,
                    "source": "linkedin",
                    "source_type": "connection",
                    "source_origin": "3",
                    "created_at": "2022-01-11 09:25:51",
                    "updated_at": "2022-01-11 09:29:47"
                }
            },
            {
                "id": 1,
                "linkedin": "jane-doe-4c1031123",
                "email": null,
                "first_name": "Jane",
                "middle_name": null,
                "last_name": "Doe",
                "headline": null,
                "summary": null,
                "address": null,
                "birthday": null,
                "premium": false,
                "influencer": false,
                "contact": {
                    "id": 34,
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "company": null,
                    "title": null,
                    "industry": null,
                    "city": null,
                    "state": null,
                    "country": null,
                    "email": null,
                    "phone": null,
                    "source": "linkedin",
                    "source_type": "conversation",
                    "source_origin": "3",
                    "created_at": "2022-01-11 09:31:07",
                    "updated_at": "2022-01-11 09:31:07"
                }
            }
        ],
        "last_event": {
            "id": 24,
            "sent_by": 4,
            "inmail": false,
            "message": "A test message.",
            "attachments": null,
            "media": null,
            "reactions": null,
            "sent_at": "2021-05-28 07:35:47"
        },
        "name": null,
        "group": false,
        "read": true,
        "archived": false,
        "important": false,
        "unread_count": 2,
        "total_count": 2,
        "activity_at": "2021-05-28 07:35:47"
    },
    "meta": {
        "success": true,
        "message": "LinkedIn conversation found."
    }
}

This endpoint retrieves a specific LinkedIn conversation.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/conversations/<ID>

URL Parameters

Parameter	Description
ID	The ID of the LinkedIn conversation to retrieve.

Get All LinkedIn Conversation Events

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/conversations/events", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 24,
            "sent_by": 4,
            "inmail": false,
            "message": "A test message.",
            "attachments": null,
            "media": null,
            "reactions": null,
            "sent_at": "2021-05-28 07:35:47"
        },
        {
            "id": 25,
            "sent_by": 4,
            "inmail": false,
            "message": "Hey!",
            "attachments": null,
            "media": null,
            "reactions": null,
            "sent_at": "2021-05-21 06:15:38"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "LinkedIn conversation events loaded."
    }
}

This endpoint retrieves all LinkedIn conversation events (such as messages, reactions, etc) for all LinkedIn conversations of your LinkedIn accounts.

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/conversations/events

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn conversation events per page to return (max 100).
with_conversation	false	Include conversation details.

Get LinkedIn Conversation Events

Example Request

use GuzzleHttp\Client;

$client = new Client();

$headers = [
  'api-key' => 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo'
];

$request = $client->request(
  'GET',
  'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events',
  [
    'headers' => $headers,
  ]
);

$response = $request->getBody()->getContents();

import http.client

connection = http.client.HTTPConnection("core.webwalker.io", 443)

payload = "{}"

headers = {
  "api-key": "TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"
}

connection.request("GET", "/api/integration/1.0/linkedin/conversations/1/events", payload, headers)

response = connection.getresponse()
data = response.read()

print(data.decode("utf-8"))

curl --request GET \
  --url "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events" \
  --header "api-key: TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo"

import axios from 'axios';

axios
  .request({
    url: 'https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events',
    method: 'get',
    headers: {
      'api-key': 'TLix6tLB8Cw9HzKXZclX4GqbeLz5hUznI5Nea7yRzPjzi3pI7npOChCyESmo',
    },
  })
  .then(({ data }) => { ... })
  .catch(error => { ... });

Example Response

{
    "data": [
        {
            "id": 24,
            "sent_by": 4,
            "inmail": false,
            "message": "A test message.",
            "attachments": null,
            "media": null,
            "reactions": null,
            "sent_at": "2021-05-28 07:35:47"
        },
        {
            "id": 25,
            "sent_by": 4,
            "inmail": false,
            "message": "Hey!",
            "attachments": null,
            "media": null,
            "reactions": null,
            "sent_at": "2021-05-21 06:15:38"
        }
    ],
    "links": {
        "first": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events?page=1",
        "last": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://core.webwalker.io/api/integration/1.0/linkedin/conversations/1/events",
        "per_page": 10,
        "to": 2,
        "total": 2,
        "success": true,
        "message": "LinkedIn conversation events loaded."
    }
}

This endpoint retrieves all LinkedIn conversation events (such as messages, reactions, etc).

HTTP Request

GET https://core.webwalker.io/api/integration/1.0/linkedin/conversations/<ID>/events

URL Parameters

Parameter	Description
ID	The ID of the LinkedIn conversation to retrieve.

Query Parameters

Parameter	Default	Description
page	1	Results page number.
per_page	10	Number of LinkedIn conversation events per page to return (max 100).