Companies

Create a company

Changed on

Creates a new company. A logo is auto-fetched from website when available. The request is idempotent when an Idempotency-Key header is supplied.

post/companies

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies
  • Auth: HTTP bearer

Request body

namestring required
websitestring

Response

Successful response.

idstring required

Unique identifier for the object. Use this value as the {id} path parameter for the company endpoints (e.g. GET /v1/companies/{id}).

object'company' required

String representing the object's type. Objects of the same type share the same value.

namestring required

Display name of the company.

slugstring required

URL-friendly slug for the company.

websitestring nullable required

Public company website URL, or null if not set.

logoUrlstring nullable required

URL of the company logo, or null if no logo is set.

summarystring nullable required

One-line summary of the company, or null if not set.

marketsstring[] required

Canonical market slugs assigned to the company.

xUrlstring nullable required

X (Twitter) profile URL, or null if not set.

linkedinUrlstring nullable required

LinkedIn page URL, or null if not set.

facebookUrlstring nullable required

Facebook page URL, or null if not set.

instagramUrlstring nullable required

Instagram profile URL, or null if not set.

createdAtstring required

Time at which the company was created. ISO 8601 datetime.

updatedAtstring nullable required

Time at which the company was last updated, or null if it has never been updated. ISO 8601 datetime.

revisioninteger required

Public Company lifecycle revision. Historical rows may be 0 until rollout backfill.

descriptionstring nullable required

Long-form description of the company (HTML), or null if not set.

canBackfillboolean nullable required

Whether automated backfill of jobs from this company is supported, or null if not yet evaluated.

jobCountnumber required

Total number of jobs at this company across all statuses.

publishedJobCountnumber required

Number of currently-published jobs at this company.

Changes

  • cee1c2d567e5Revision changes
    • breaking

      the request property became not nullable

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

  • c34152c38176Revision changes
    • warning

      the request property's maxLength was set to 120

    • warning

      the request property's maxLength was set to 200

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status