Companies

List and manage companies. A company is shared by multiple contacts. Use GET to retrieve company details, PATCH to update.

GET /api/companies

List companies

Example request

curl -X GET "https://www.letsligo.com/api/companies" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

Request parameters

Name	Type	Description	Required
page	integer	Page number for paginated results (default: 1).	No
itemsPerPage	integer		No
search	string		No

Response example

{
    "member": [
        {
            "id": "523e4567-e89b-12d3-a456-426614174000",
            "name": "Acme Corp",
            "website": "https://acme.com",
            "industry": "Technology",
            "size": "50-200",
            "headquarters": "Paris, France",
            "createdAt": "2025-03-13T10:00:00+00:00",
            "updatedAt": "2025-03-13T14:00:00+00:00"
        }
    ],
    "totalItems": 1
}

Response attributes

Name	Type	Description
totalItems	integer	Total number of items in the collection.

GET /api/companies/{id}

Get a company

Example request

curl -X GET "https://www.letsligo.com/api/companies/523e4567-e89b-12d3-a456-426614174000" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

Request parameters

Name	Type	Description	Required
id	string (uuid)	Unique identifier (UUID) of the resource.	Yes

Response example

{
    "id": "523e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "website": "https://acme.com",
    "industry": "Technology",
    "founded": "2015",
    "revenue": "10M-50M",
    "size": "50-200",
    "headquarters": "Paris, France",
    "description": "Leading provider of innovative solutions.",
    "domain": "acme.com",
    "linkedinUrl": "https://linkedin.com/company/acme",
    "createdAt": "2025-03-13T10:00:00+00:00",
    "updatedAt": "2025-03-13T14:00:00+00:00"
}

PATCH /api/companies/{id}

Update a company

Example request

curl -X PATCH "https://www.letsligo.com/api/companies/523e4567-e89b-12d3-a456-426614174000" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{   "industry": "Technology",   "size": "50-200" }'

Request body

{
    "industry": "Technology",
    "size": "50-200"
}

Request parameters

Name	Type	Description	Required
id	string (uuid)	Unique identifier (UUID) of the resource.	Yes
name	string		No
website	string		No
industry	string		No
founded	string		No
revenue	string		No
size	string		No
headquarters	string		No
description	string		No
domain	string		No
linkedinUrl	string		No