Introduction

The root URL for the Consider Boards API is https://boards.considerapi.com/v0.

All data is sent and received as JSON using the Unicode UTF-8 character encoding. All requests must be authenticated.

Authentication

To authorize, use this code:


curl -H "X-API-Key: your_api_key"

Make sure to replace your_api_key with your API key.

Authentication to the Boards API is handled by sending your API key via the X-API-Key HTTP request header.

You can get an API key by contacting your designated customer success manager or by submitting a request to support@consider.com.

Consider expects for the API key to be included in all API requests to the server in a header that looks like the following:

X-API-Key: your_api_key

You must replace your_api_key with your API key.

Requests

A request URL is composed of the root URL and the endpoint path. The endpoint path may have one or more required parameters. Optional parameters are passed in the query string. An example of a request URL with both required and optional parameters is:

https://boards.considerapi.com/v0/company/domain/example.com/jobs?limit=5&offset=5

Responses

An example of an error response follows:

{
  "error": "Not Found",
  "message": "Invalid domain",
  "request": "https://boards.considerapi.com/v0/company/domain/example.com",
  "status": 404,
  "timestamp": "2021-11-09T11:16:24.864326"
}

Requests to the API may fail for any number of reasons. In such cases, the HTTP status code will indicate the type of failure and the body of the response will contain more information about the failure formatted in JSON. A successful response will return a 200 HTTP status code and the body of the response will contain the result formatted in JSON.

The following table explains the status codes commonly returned by the API:

Status Code	Status	Comment
200	OK	Request completed successfully and returns a response.
403	Forbidden	Request failed because the API key is invalid.
404	Not Found	Request failed. Refer to the response for more details.
500	Internal Server Error	Request failed because of an internal failure.

Pagination

An example of the pagination data from a list response follows:

{
  "hasNext": true,
  "links": {
    "first": "https://boards.considerapi.com/v0/company/domain/example.com/jobs?limit=5",
    "next": "https://boards.considerapi.com/v0/company/domain/example.com/jobs?limit=5&offset=5"
  },
  "offset": 5
}

Some API endpoints return data specific to a single entity, while other endpoints return a list of entities. An endpoint that returns a list of entities will support pagination over the result set via the following attributes:

Attribute	Type	Comment
hasNext	Boolean	Indicates whether there are more results available.
offset	String	The offset token that must be sent to the API endpoint to request the next set of results.
links	List	Contains a number of URLs that facilitate pagination over the result set. “first” will return the first set of results. “next”, if it exists, will return the next set of results.

The URLs in links are guaranteed to be correct and of a format that is supported by the API endpoint. As such, it is strongly recommended that the URLs in links are used for pagination instead of attempting to create the URLs manually.

Boards API Reference

Company

This endpoint retrieves a company by its domain.

Request:

curl -H "X-API-Key: your_api_key" https://boards.considerapi.com/v0/company/domain/example.com

Response example:

{
  "data": {
    "boardUrl": "https://consider.com/boards/vc/consider/jobs/example",
    "domain": "example.com",
    "links": {
      "jobs": "https://boards.considerapi.com/v0/company/domain/example.com/jobs"
    },
    "logos": [
      {
        "height": 100,
        "src": "https://dzh2zima160vx.cloudfront.net/profile/fab6cdc610c2c30dc31bae3afd03819a_100_100...",
        "width": 100
      }
    ],
    "markets": [
      "IT and Services",
      "Fintech"
    ],
    "name": "Example",
    "numJobs": 275,
    "slug": "example"
  },
  "links": null
}

HTTP Request

GET /company/domain/:domain

Request Parameters:

Parameter	Required	Type	Comment
domain	TRUE	String	The domain of the child company for which company data will be returned.

Response:

Attribute	Type	Comment
boardUrl	URL	The board URL associated with the company.
description	String	The description of the company.
domain	String	The domain of the company.
funding	String	The funding stage of the company.
links	List	URLs to endpoints that return derivative information associated with the company.
logos	List	List of logo images
logos.height	Numeric	height in pixels of logo image
logos.src	URL	URL for company logo image
logos.width	Numeric	width in pixels of logo image
markets	List	List of markets the company is associated with
name	String	The canonical name of the company.
numJobs	Numeric	The number of jobs associated with the company.
slug	String	The slug associated with the company.
staffCount	Numeric	A highly approximate staff count of the company.

Companies

This endpoint retrieves companies by their domain(s)

Request:

curl -H "X-API-Key: your_api_key" "https://boards.considerapi.com/v0/companies?domains=foo.com,bar.com"

Response example:

{
  "data": [
    {
      "boardUrl": "https://consider.com/boards/vc/consider/jobs/foo",
      "domain": "foo.com",
      "links": {
        "jobs": "https://boards.considerapi.com/v0/company/domain/foo.com/jobs"
      },
      "logos": [
        {
          "height": 100,
          "src": "https://dzh2zima160vx.cloudfront.net/profile/dd36cdc610c2c30dc31bae3afd03819a_100_100...",
          "width": 100
        }
      ],
      "markets": [
        "IT and Services",
        "Fintech"
      ],
      "name": "Foo",
      "numJobs": 145,
      "slug": "foo"
    },
    {
      "boardUrl": "https://consider.com/boards/vc/consider/jobs/bar",
      "domain": "bar.com",
      "links": {
        "jobs": "https://boards.considerapi.com/v0/company/domain/bar.com/jobs"
      },
      "logos": [
        {
          "height": 100,
          "src": "https://dzh2zima160vx.cloudfront.net/profile/fab6cdc610c2c30dc31bae3afd03819a_100_100...",
          "width": 100
        }
      ],
      "markets": [
        "IT and Services",
        "Fintech"
      ],
      "name": "Bar",
      "numJobs": 49,
      "slug": "bar"
    }
  ],
  "hasNext": false,
  "links": {
    "first": "https://boards.considerapi.com/v0/companies?domains=foo.com%2Cbar.com&limit=100&offset=0"
  },
  "offset": null
}

HTTP Request

GET /companies

Request Parameters:

Parameter	Required	Type	Comment
domains	FALSE	String	A comma separated list of domains of the child companies for which company data will be returned. If not specified all company data from the board will be returned.

Response:

Attribute	Type	Comment
boardUrl	URL	The board URL associated with the company.
description	String	The description of the company.
domain	String	The domain of the company.
funding	String	The funding stage of the company.
links	List	URLs to endpoints that return derivative information associated with the company.
logos	List	List of logo images
logos.height	Numeric	height in pixels of logo image
logos.src	URL	URL for company logo image
logos.width	Numeric	width in pixels of logo image
markets	List	List of markets the company is associated with
name	String	The canonical name of the company.
numJobs	Numeric	The number of jobs associated with the company.
slug	String	The slug associated with the company.
staffCount	Numeric	A highly approximate staff count of the company.

Board Jobs

This endpoint retrieves jobs for a board with optional filtering options.

Request:

curl -H "X-API-Key: your_api_key" https://boards.considerapi.com/v0/jobs

Response example:

{
  "data": [
    {
      "companyDomain": "xyz.io",
      "companyLogos": [
        {
          "height": 100,
          "src": "https://dzh2zima160vx.cloudfront.net/profile/fab6cdc610c2c30dc31bae3afd03819a_100_100...",
          "width": 100
        }
      ],
      "companyName": "Xyz Io",
      "createdAt": "2022-08-01T18:05:32",
      "description": "Some sort of description",
      "functions": [
        "Engineering"
      ],
      "isFeatured": true,
      "locations": [
        "Toronto, Canada"
      ],
      "remote": false,
      "salary": {
        "currency": "EUR",
        "maxValue": 32000,
        "minValue": 30000,
        "period": "Year"
      },
      "seniorities": [
        "Mid",
        "Junior"
      ],      
      "skills": [
        "Distributed Systems",
        "MySQL",
        "Java",
        "Golang",
        "MongoDB"
      ],
      "title": "Staff Software Engineer, Online Databases",
      "url": "https://boards.xyz.io/example/jobs/3438396",
      "yearsExperience": {
        "max": 10,
        "min": 5
      }      
    }
  ],
  "hasNext": true,
  "links": {
    "first": "https://boards.considerapi.com/v0/jobs?limit=5",
    "next": "https://boards.considerapi.com/v0/jobs?limit=5&offset=5"
  },
  "offset": 5
}

HTTP Request

GET /jobs

Request parameters

Parameter	Required	Type	Comment
description	FALSE	Boolean	Set if job descriptions should be shown.
jobTypes	FALSE	String	The title of a job to filter on.
skills	FALSE	String	The name of a skill to filter on.
markets	FALSE	String	The market/industry category of companies to filter on.
offset	FALSE	String	The offset token that refers to the next set of results. If no offset token is supplied, then the first set of results will be returned.
limit	FALSE	Numeric	The desired number of results to be returned. A valid value is between 1 and 50. The default value is 5.

Response

Attribute	Type	Comment
companyLogos	List	List of logo images
companyLogos.height	Numeric	height in pixels of logo image
companyLogos.src	URL	URL for company logo image
companyLogos.width	Numeric	width in pixels of logo image
companyDomain	String	The domain of the company.
companyName	String	The canonical name of the company.
createdAt	String	The time the job was first seen or posted as an ISO formatted string.
description	String	The job description as html/text. Only provided if the description request parameter is set.
functions	Array of String	The functional area(s) of the job such as Engineering.
isFeatured	Boolean	Set if the job is considered featured.
locations	Array of String	The locations of the job.
remote	Boolean	Set if the job is considered remote.
salary.currency	String	The three character currency code for this salary.
salary.maxValue	Numeric	The high end of the salary range in currency units specified in salary.currency
salary.minValue	Numeric	The low end of the salary range in currency units specified in salary.currency
salary.period	String	The pay interval of the salary. One of (Hour, Day, Week, Month, Year)
seniorities	Array of String	The level(s) of seniority the job role encompasses.
skills	Array of String	The skills mentioned in the job posting.
title	String	The title of the job.
url	URL	The URL of the job.
yearsExperience.max	Numeric	The maximum number of years of experience the job is seeking.
yearsExperience.min	Numeric	The minimum number of years of experience the job is seeking.

Domain Jobs

This endpoint retrieves jobs for a company by domain

Request:

curl -H "X-API-Key: your_api_key" https://boards.considerapi.com/v0/company/domain/example.com/jobs

Response example:

{
  "data": [
    {
      "companyDomain": "xyz.io",
      "companyLogos": [
        {
          "height": 100,
          "src": "https://dzh2zima160vx.cloudfront.net/profile/fab6cdc610c2c30dc31bae3afd03819a_100_100...",
          "width": 100
        }
      ],
      "companyName": "Xyz Io",
      "createdAt": "2022-08-01T18:05:32",
      "description": "Some sort of description",
      "isFeatured": true,      
      "functions": [
        "Engineering"
      ],
      "locations": [
        "Toronto, Canada"
      ],
      "remote": false,
      "salary": {
        "currency": "EUR",
        "maxValue": 32000,
        "minValue": 30000,
        "period": "Year"
      },
      "seniorities": [
        "Mid",
        "Junior"
      ],        
      "skills": [
        "Distributed Systems",
        "MySQL",
        "Java",
        "Golang",
        "MongoDB"
      ],
      "title": "Staff Software Engineer, Online Databases",
      "url": "https://boards.xyz.io/example/jobs/3438396",
      "yearsExperience": {
        "max": 10,
        "min": 5
      }
    }
  ],
  "hasNext": true,
  "links": {
    "first": "https://boards.considerapi.com/v0/company/domain/example.com/jobs?limit=5",
    "next": "https://boards.considerapi.com/v0/company/domain/example.com/jobs?limit=5&offset=5"
  },
  "offset": 5
}

HTTP Request

GET /company/domain/:domain/jobs

Request parameters

Parameter	Required	Type	Comment
description	FALSE	Boolean	Set if job descriptions should be shown.
domain	TRUE	String	The domain of the child company for which job data will be returned.
offset	FALSE	String	The offset token that refers to the next set of results. If no offset token is supplied, then the first set of results will be returned.
limit	FALSE	Numeric	The desired number of results to be returned. A valid value is between 1 and 50. The default value is 5.

Response

Attribute	Type	Comment
companyLogos	List	List of logo images
companyLogos.height	Numeric	height in pixels of logo image
companyLogos.src	URL	URL for company logo image
companyLogos.width	Numeric	width in pixels of logo image
companyDomain	String	The domain of the company.
companyName	String	The canonical name of the company.
createdAt	String	The time the job was first seen or posted as an ISO formatted string.
description	String	The job description as html/text. Only provided if the description request parameter is set.
functions	Array of String	The functional area(s) of the job such as Engineering.
isFeatured	Boolean	Set if the job is considered featured.
locations	Array of String	The locations of the job.
remote	Boolean	Set if the job is considered remote.
salary.currency	String	The three character currency code for this salary.
salary.maxValue	Numeric	The high end of the salary range in currency units specified in salary.currency
salary.minValue	Numeric	The low end of the salary range in currency units specified in salary.currency
salary.period	String	The pay interval of the salary. One of (Hour, Day, Week, Month, Year)
seniorities	Array of String	The level(s) of seniority the job role encompasses.
skills	Array of String	The skills mentioned in the job posting.
title	String	The title of the job.
url	URL	The URL of the job.
yearsExperience.max	Numeric	The maximum number of years of experience the job is seeking.
yearsExperience.min	Numeric	The minimum number of years of experience the job is seeking.

Board

This endpoint retrieves aggregate information about a job board.

Request:

curl -H "X-API-Key: your_api_key" https://boards.considerapi.com/v0/board

Response example:

{
  "data": {
    "numCompanies": 330,
    "numJobs": 12384
  },
  "links": null
}

HTTP Request

GET /board

Request parameters

None

Response

Attribute	Type	Comment
numCompanies	Numeric	The number of companies in the job board.
numJobs	Numeric	The aggregate number of jobs in the job board.