Skip to main content
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>'
{
  "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": "[email protected]",
      "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
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact [email protected]

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

​
email
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[]
​
meta
object