Companies

Accounts: the organisations you sell to or support.

GET List companies
POST Create a company
GET Get a company
PATCH Update a company
DELETE Archive a company

#List companies

GET/api/v1/companies

Operation list_companies · needs scope companies:read

Parameter	In	Type	Notes
`limit`	query	integer	Page size, at most 100.
`cursor`	query	string	`pagination.nextCursor` from the previous page.
`sort`	query	-updated_at \| updated_at \| -created_at \| created_at	Sort order. A leading minus sorts descending.
`updated_since`	query	datetime	Only records updated at or after this instant.
`q`	query	string	Free-text search over the object's main columns.
`domain`	query	string	Only records whose domain equals this.
`industry`	query	string	Only records whose industry equals this.
`lifecycle_stage`	query	string	Only records whose lifecycle_stage equals this.
`owner`	query	string	Only records whose owner equals this.
`country`	query	string	Only records whose country equals this.
`tier`	query	string	Only records whose tier equals this.

bash

curl https://synconone.com/api/v1/companies \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": [
    {
      "id": "pr_1a2b3c4d5e6f7a8b",
      "object": "string",
      "name": "Emily Carter",
      "domain": "example.com",
      "website": "https://example.com",
      "industry": "string",
      "employee_count": 1,
      "annual_revenue_cents": 1,
      "phone": "+61 400 000 000",
      "lifecycle_stage": "lead"
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Create a company

POST/api/v1/companies

Operation create_company · needs scope companies:write

Built-in and custom fields by key. Relations take public ids.

Body field	Type	Notes
`name`	string	Name
`domain`	string	Domain
`website`	string	Website
`industry`	string	Industry
`employee_count`	number	Employees
`annual_revenue_cents`	number	Annual revenue
`phone`	string	Phone
`lifecycle_stage`	lead \| prospect \| customer \| churned	Lifecycle stage
`tier`	string	Tier
`source`	string	Source
`owner`	string	Owner
`address_line`	string	Address
`city`	string	City
`region`	string	Region
`country`	string	Country
`time_zone`	string	Time zone
`tags`	list of string	Tags
`description`	string	About

bash

curl -X POST https://synconone.com/api/v1/companies \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Emily Carter","domain":"example.com","website":"https://example.com","industry":"string","employee_count":1}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "name": "Emily Carter",
    "domain": "example.com",
    "website": "https://example.com",
    "industry": "string",
    "employee_count": 1,
    "annual_revenue_cents": 1,
    "phone": "+61 400 000 000",
    "lifecycle_stage": "lead"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Get a company

GET/api/v1/companies/{id}

Operation get_company · needs scope companies:read

Parameter	In	Type	Notes
`id` required	path	string	Public id of the company.

bash

curl https://synconone.com/api/v1/companies/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "name": "Emily Carter",
    "domain": "example.com",
    "website": "https://example.com",
    "industry": "string",
    "employee_count": 1,
    "annual_revenue_cents": 1,
    "phone": "+61 400 000 000",
    "lifecycle_stage": "lead"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Update a company

PATCH/api/v1/companies/{id}

Operation update_company · needs scope companies:write

Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and details.applied lists what was already changed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the company.

Body field	Type	Notes
`name`	string	Name
`domain`	string	Domain
`website`	string	Website
`industry`	string	Industry
`employee_count`	number	Employees
`annual_revenue_cents`	number	Annual revenue
`phone`	string	Phone
`lifecycle_stage`	lead \| prospect \| customer \| churned	Lifecycle stage
`tier`	string	Tier
`source`	string	Source
`owner`	string	Owner
`address_line`	string	Address
`city`	string	City
`region`	string	Region
`country`	string	Country
`time_zone`	string	Time zone
`tags`	list of string	Tags
`description`	string	About

bash

curl -X PATCH https://synconone.com/api/v1/companies/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Emily Carter","domain":"example.com","website":"https://example.com","industry":"string","employee_count":1}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "name": "Emily Carter",
    "domain": "example.com",
    "website": "https://example.com",
    "industry": "string",
    "employee_count": 1,
    "annual_revenue_cents": 1,
    "phone": "+61 400 000 000",
    "lifecycle_stage": "lead"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Archive a company

DELETE/api/v1/companies/{id}

Operation archive_company · needs scope companies:write

Archives the record (it can be restored in the app). Nothing is destroyed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the company.

bash

curl -X DELETE https://synconone.com/api/v1/companies/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "archived": true
  }
}