Company Contacts

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "789123",
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "status": "active",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@acmecorp.com",
      "phone": "555-987-6543",
      "phone_2": "555-555-5555",
      "full_name": "John Smith",
      "company_id": "123456",
      "company": {
        "id": "123456",
        "name": "Acme Corporation"
      },
      "is_primary": true,
      "receive_quotation_pdf": false,
      "receive_purchase_order_pdf": false,
      "receive_purchase_order_invoice_pdf": false,
      "has_portal_login": false,
      "companies": [
        {
          "id": 123,
          "name": "<string>",
          "is_primary": true,
          "receive_quotation_pdf": true,
          "receive_purchase_order_pdf": true,
          "receive_purchase_order_invoice_pdf": true
        }
      ],
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "error": "Not Found",
  "message": "The requested resource could not be found",
  "status_code": 404
}

Companies

Company Contacts

Get a paginated list of contacts associated with a specific company.

For detailed information about the filtering system and available operators, refer to the Filter System Documentation.

Available Filters

String Filters

first_name: Contact first name
last_name: Contact last name
email: Contact email
phone: Contact phone number
status: Contact status
company.name: Company name

DateTime Filters

created_at: When the contact was created
updated_at: When the contact was last updated

GET

companies

{companyId}

contacts

Company Contacts

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "789123",
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "status": "active",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@acmecorp.com",
      "phone": "555-987-6543",
      "phone_2": "555-555-5555",
      "full_name": "John Smith",
      "company_id": "123456",
      "company": {
        "id": "123456",
        "name": "Acme Corporation"
      },
      "is_primary": true,
      "receive_quotation_pdf": false,
      "receive_purchase_order_pdf": false,
      "receive_purchase_order_invoice_pdf": false,
      "has_portal_login": false,
      "companies": [
        {
          "id": 123,
          "name": "<string>",
          "is_primary": true,
          "receive_quotation_pdf": true,
          "receive_purchase_order_pdf": true,
          "receive_purchase_order_invoice_pdf": true
        }
      ],
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "error": "Not Found",
  "message": "The requested resource could not be found",
  "status_code": 404
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

companyId

string

required

The unique identifier of the company

Query Parameters

page

integer

default:1

Page number for pagination (starts at 1)

Required range: x >= 1

limit

integer

default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100

first_name

string

Filter by contact first name

last_name

string

Filter by contact last name

string

Filter by contact email

phone

string

Filter by contact phone number

status

string

Filter by contact status

company.name

string

Filter by company name

created_at

string<date-time>

Filter by creation date

updated_at

string<date-time>

Filter by last update date

Response

A list of company contacts

data

object[]

Show child attributes

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Company Contacts

Available Filters

String Filters

DateTime Filters

Authorizations

Path Parameters

Query Parameters

Response