Mantiks API

https://mantiks-api.readme.io
Admin
Mantiks API enables developers to search for companies based on job postings from LinkedIn, Indeed,...
Tokens:16,159
Snippets:63
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Jobs Response Example (JSON)

Source: https://mantiks-api.readme.io/reference/search

This JSON object represents a successful response when retrieving job listings. It includes details about the jobs found, company information, and pagination details like the next offset.

```json
{
	"companies": [
		{
			"ae14": "ae14",
			"jobs": [
				{
					"date_creation": "2024-11-13T16:45:35.885895",
					"description": "...",
					"job_board": "linkedin",
					"job_board_id": 4075550083,
					"job_board_url": "https://www.linkedin.com/jobs/view/4075550083",
					"job_id": "e5ef694f-09cf-4dd2-b67f-eb497b80ad79",
					"job_title": "Product & Merchandising Manager",
					"last_seen": "2024-11-15T01:16:15.646267",
					"location": "Paris, Île-de-France, France",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
					},
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
				}
			],
			"max_company_size": 50,
			"min_company_size": 11,
			"name": "melvinandahamiltondigital",
			"social_urls": {
				"facebook": "https://www.facebook.com/Melvin.and.Hamilton",
				"linkedin": "https://www.linkedin.com/company/melvin-&-hamilton-digital/",
				"twitter": "https://twitter.com/MelvinHamilton"
			},
			"website": "http://www.melvin-hamilton.com"
		}
	],
	"credits_cost": 3,
	"credits_remaining": 4556,
	"nb_companies": 3,
  "nb_jobs": 3,
  "next_offset": "abc"
}
```

--------------------------------

### GET /companies

Source: https://mantiks-api.readme.io/reference/search

Retrieve a list of companies, with options to filter by industry, funding status, and pagination.

```APIDOC
## GET /companies

### Description
Retrieve a list of companies, with options to filter by industry, funding status, and pagination.

### Method
GET

### Endpoint
/companies

### Parameters
#### Query Parameters
- **company_industry** (array of strings) - Optional - Filter companies based on their industry.
- **company_industry_excluded** (array of strings) - Optional - Filter companies by excluding a list of industry. By default recruiting and consulting companies are excluded.
- **company_funding** (boolean) - Optional - Filter companies based on their fundings. Defaults to false.
- **limit** (integer) - Optional - Limit the volume of results in the answer. Maximum 500. Defaults to 10.
- **offset** (string) - Optional - Use to paginate results. Use "next_offset" from previous result to get the next page.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **companies** (array) - A list of company objects.
  - **id** (string) - The unique identifier of the company.
  - **jobs** (array) - A list of job postings associated with the company.
    - **date_creation** (string) - The date and time the job was created.
    - **description** (string) - A description of the job.
    - **job_board** (string) - The job board where the listing was found.
    - **job_board_id** (string/integer) - The unique identifier of the job on the job board.
    - **job_board_url** (string) - The URL of the job listing on the job board.
    - **job_id** (string) - The unique identifier of the job within Mantiks.
    - **job_title** (string) - The title of the job.
    - **last_seen** (string) - The last time the job posting was seen.
    - **location** (string) - The location of the job.
    - **salary** (object) - Salary information for the job.
      - **min** (integer) - The minimum salary offered.
      - **max** (integer) - The maximum salary offered.
      - **type** (string) - The salary type (e.g., "YEARLY").
    - **job_seniority** (string) - The seniority level of the job.
    - **job_type** (string) - The type of employment (e.g., "Full-time").
    - **sectors** (array of strings) - The industry sectors the job belongs to.
    - **indeed_easy_apply** (boolean) - Indicates if the job can be applied for easily via Indeed.
    - **indeed_apply_url** (string) - The URL for applying to the job via Indeed.
    - **linkedin_recruiter_name** (string) - The name of the recruiter on LinkedIn.
    - **linkedin_recruiter_title** (string) - The title of the recruiter on LinkedIn.
    - **linkedin_recruiter_link** (string) - A link to the recruiter's profile on LinkedIn.
    - **linkedin_apply_url** (string) - The URL for applying to the job via LinkedIn.
  - **max_company_size** (integer) - The maximum number of employees in the company.
  - **min_company_size** (integer) - The minimum number of employees in the company.
  - **name** (string) - The name of the company.
  - **social_urls** (object) - Social media profile URLs for the company.
    - **facebook** (string) - Facebook profile URL.
    - **linkedin** (string) - LinkedIn profile URL.
    - **twitter** (string) - Twitter profile URL.
  - **website** (string) - The company's website URL.

#### Response Example
```json
{
  "companies": [
    {
      "id": "93354b80-a141-470d-8961-fcd4efbc2fbb",
      "jobs": [
        {
          "date_creation": "2024-11-13T20:28:33.074005",
          "description": "...",
          "job_board": "linkedin",
          "job_board_id": 4075138266,
          "job_board_url": "https://www.linkedin.com/jobs/view/4075138266",
          "job_id": "a1552ed8-9027-4ea2-9a39-06e7d1320639",
          "job_title": "Manager de production F/H",
          "last_seen": "2024-11-15T06:59:00.212556",
          "location": "Bourg-lès-Valence, Auvergne-Rhône-Alpes, France",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
          },
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
        }
      ],
      "max_company_size": 50,
      "min_company_size": 11,
      "name": "bellonandfils",
      "social_urls": {
        "facebook": "https://www.facebook.com/BellonFils",
        "linkedin": "https://www.linkedin.com/company/bellon-fils"
      },
      "website": "https://bellon.fr"
    },
    {
      "id": "4b8bbffd-54d7-4146-b188-026e1b442b73",
      "jobs": [
        {
          "date_creation": "2024-11-13T02:53:29.470915",
          "description": "...",
          "job_board": "indeed",
          "job_board_id": "75a6cf11606640dc",
          "job_board_url": "https://www.indeed.com/viewjob?vjs=3&jk=75a6cf11606640dc",
          "job_id": "51f5efb6-a6ac-4243-a765-0ecd78869ae8",
          "job_title": "Accounting Manager- D.R.",
          "last_seen": "2024-11-13T11:44:03.686091",
          "location": "Ports (37)",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
          },
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
        }
      ],
      "max_company_size": 5000,
      "min_company_size": 1001,
      "name": "tropicalshipping",
      "social_urls": {
        "facebook": "https://www.facebook.com/TropicalShippingOffical/",
        "linkedin": "https://www.linkedin.com/company/tropical-shipping-official/",
        "twitter": "https://twitter.com/TropicalShippin"
      },
      "website": "https://www.tropical.com"
    },
    {
      "id": "1d580f5d-0ca6-447a-a27a-d8af487c"
    }
  ]
}
```
```

--------------------------------

### GET /jobs

Source: https://mantiks-api.readme.io/reference/enrich

Retrieves a list of jobs based on specified criteria. It returns the number of jobs found, details of each job, and the remaining credits.

```APIDOC
## GET /jobs

### Description
Retrieves a list of jobs based on specified criteria. It returns the number of jobs found, details of each job, and the remaining credits.

### Method
GET

### Endpoint
/jobs

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of jobs to skip before starting to collect the result set.
- **credits_cost** (integer) - Optional - The number of credits to spend for the request.
- **location** (string) - Optional - The location to search for jobs.
- **description** (string) - Optional - The description to search for jobs.
- **job_title** (string) - Optional - The job title to search for jobs.

### Request Example
```json
{
  "credits_remaining": 4560,
  "jobs": [
    {
      "date_creation": "2023-06-14T00:41:30.644058",
      "last_seen": "2023-07-14T01:22:09.098543",
      "description": "...",
      "job_board": "indeed",
      "job_board_url": "https://www.indeed.com/viewjob?vjs=3&jk=9381c6dc1f1af9af",
      "job_title": "Critical Environment Program Manager",
      "location": "Paris (75)"
    },
    {
      "date_creation": "2023-05-20T13:55:20.168446",
      "description": "...",
      "job_board": "linkedin",
      "job_board_url": "https://www.linkedin.com/jobs/view/3609884725",
      "job_title": "Technical Program Manager - Datacenter Engineering - EMEA",
      "location": "Rouen, Normandy, France"
    }
  ],
  "nb_jobs": 2,
  "next_offset": null,
  "credits_remaining": 789,
  "credits_cost": 1,
  "success": true
}
```

### Response
#### Success Response (200)
- **credits_remaining** (integer) - The number of credits remaining.
- **jobs** (array) - An array of job objects.
  - **date_creation** (string) - The date the job was created.
  - **last_seen** (string) - The last time the job was seen.
  - **description** (string) - The description of the job.
  - **job_board** (string) - The job board where the job was found.
  - **job_board_url** (string) - The URL of the job posting.
  - **job_title** (string) - The title of the job.
  - **location** (string) - The location of the job.
- **nb_jobs** (integer) - The total number of jobs found.
- **next_offset** (integer) - The offset for the next page of results, or null if there are no more results.
- **credits_cost** (integer) - The cost in credits for this request.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "credits_remaining": 4560,
  "jobs": [
    {
      "date_creation": "2023-06-14T00:41:30.644058",
      "last_seen": "2023-07-14T01:22:09.098543",
      "description": "...",
      "job_board": "indeed",
      "job_board_url": "https://www.indeed.com/viewjob?vjs=3&jk=9381c6dc1f1af9af",
      "job_title": "Critical Environment Program Manager",
      "location": "Paris (75)"
    },
    {
      "date_creation": "2023-05-20T13:55:20.168446",
      "description": "...",
      "job_board": "linkedin",
      "job_board_url": "https://www.linkedin.com/jobs/view/3609884725",
      "job_title": "Technical Program Manager - Datacenter Engineering - EMEA",
      "location": "Rouen, Normandy, France"
    }
  ],
  "nb_jobs": 2,
  "next_offset": null,
  "credits_remaining": 789,
  "credits_cost": 1,
  "success": true
}
```

### Error Handling
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
```

--------------------------------

### GET /companies/search

Source: https://mantiks-api.readme.io/reference/search

Search for companies based on job recruitment criteria and apply filters for job titles, descriptions, and company attributes.

```APIDOC
## GET /companies/search

### Description
Find companies based on their recruitment activities. Results are grouped by company, showing the top 10 matching jobs per company.

### Method
GET

### Endpoint
/companies/search

### Parameters
#### Query Parameters
- **job_title** (string) - Optional - Keywords to match in job titles (Exact match logic).
- **job_description** (string) - Optional - Keywords to match in job descriptions.
- **job_title_include_all** (boolean) - Optional - If true, uses 'AND' logic for multiple keywords in job titles.
- **job_description_include_all** (boolean) - Optional - If true, uses 'AND' logic for multiple keywords in job descriptions.
- **exclude_keywords** (string) - Optional - Keywords to exclude from search (uses 'OR' logic).
- **company_size** (string) - Optional - Filter by company size.
- **industry** (string) - Optional - Filter by industry (see Industry reference).
- **offset** (string) - Optional - Pagination cursor for results.

### Request Example
GET /companies/search?job_title=sales&company_size=large

### Response
#### Success Response (200)
- **companies** (array) - List of companies matching criteria.
- **next_offset** (string) - Cursor for the next page of results.

#### Response Example
{
  "companies": [
    {
      "company_name": "Example Corp",
      "jobs": [{"title": "Sales Manager"}]
    }
  ],
  "next_offset": "abc123xyz"
}
```

--------------------------------

### Example API Response for Companies

Source: https://mantiks-api.readme.io/reference/search

This JSON structure represents a successful response (200 OK) from the API, containing a list of companies. Each company object includes details like ID, size, social URLs, website, and a list of associated jobs with their respective details.

```json
{
	"companies": [
		{
			"id": "93354b80-a141-470d-8961-fcd4efbc2fbb",
			"jobs": [
				{
					"date_creation": "2024-11-13T20:28:33.074005",
					"description": "...",
					"job_board": "linkedin",
					"job_board_id": 4075138266,
					"job_board_url": "https://www.linkedin.com/jobs/view/4075138266",
					"job_id": "a1552ed8-9027-4ea2-9a39-06e7d1320639",
					"job_title": "Manager de production F/H",
					"last_seen": "2024-11-15T06:59:00.212556",
					"location": "Bourg-lès-Valence, Auvergne-Rhône-Alpes, France",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
					},
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
				}
			],
			"max_company_size": 50,
			"min_company_size": 11,
			"name": "bellonandfils",
			"social_urls": {
				"facebook": "https://www.facebook.com/BellonFils",
				"linkedin": "https://www.linkedin.com/company/bellon-fils"
			},
			"website": "https://bellon.fr"
		},
		{
			"id": "4b8bbffd-54d7-4146-b188-026e1b442b73",
			"jobs": [
				{
					"date_creation": "2024-11-13T02:53:29.470915",
					"description": "...",
					"job_board": "indeed",
					"job_board_id": "75a6cf11606640dc",
					"job_board_url": "https://www.indeed.com/viewjob?vjs=3&jk=75a6cf11606640dc",
					"job_id": "51f5efb6-a6ac-4243-a765-0ecd78869ae8",
					"job_title": "Accounting Manager- D.R.",
					"last_seen": "2024-11-13T11:44:03.686091",
					"location": "Ports (37)",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
					},
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
				}
			],
			"max_company_size": 5000,
			"min_company_size": 1001,
			"name": "tropicalshipping",
			"social_urls": {
				"facebook": "https://www.facebook.com/TropicalShippingOffical/",
				"linkedin": "https://www.linkedin.com/company/tropical-shipping-official/",
				"twitter": "https://twitter.com/TropicalShippin"
			},
			"website": "https://www.tropical.com"
		},
		{
			"id": "1d580f5d-0ca6-447a-a27a-d8af487c"
		}
	]
}
```

--------------------------------

### GET /company/search

Source: https://mantiks-api.readme.io/reference/search

Finds companies and their recruitments based on specific job filters and company criteria.

```APIDOC
## GET /company/search

### Description
This endpoint allows you to find companies and their recruitments based on current or post jobs filters.

### Method
GET

### Endpoint
https://api.mantiks.io/company/search

### Parameters
#### Query Parameters
- **job_age_in_days** (integer) - Required - Maximum age in days since the job has been published
- **job_location_ids** (array) - Required - One or many ids of location to filter job
- **job_title** (array) - Optional - One or many keywords to filter job title
- **job_title_include_all** (boolean) - Optional - Control the behavior of the boolean query on keyword to find inside the job_title
- **job_title_excluded** (array) - Optional - One or many keywords to exclude from job title
- **job_description** (array) - Optional - One or many keywords to filter job description
- **job_description_include_all** (boolean) - Optional - Control the behavior of the boolean query on keyword_description
- **job_description_excluded** (array) - Optional - One or many keywords to exclude from job description
- **job_board** (string) - Optional - Select jobs from a specific job board (indeed, linkedin, wttj, glassdoor)
- **nb_min_job_posted** (integer) - Optional - Filter companies based on the minimum number of jobs posted
- **nb_max_job_posted** (integer) - Optional - Filter companies based on the maximum number of jobs posted
- **min_company_size** (integer) - Optional - Filter companies based on the minimum number of employees
- **max_company_size** (integer) - Optional - Filter companies based on the maximum number of employees

### Request Example
GET https://api.mantiks.io/company/search?job_age_in_days=30&job_location_ids=123

### Response
#### Success Response (200)
- **companies** (array) - List of companies matching the criteria

#### Response Example
{
  "companies": [
    {
      "id": "comp_001",
      "name": "Example Corp"
    }
  ]
}
```

--------------------------------

### GET /company/search

Source: https://mantiks-api.readme.io/reference/getting-started-with-your-api-1

Find companies and their recruitments based on current or post jobs filters. Results are grouped by companies, showing the top 10 matching jobs for each.

```APIDOC
## GET /company/search

### Description
This endpoint allows you to find companies and their recruitments based on current or post jobs filters. The results will show the top 10 matching jobs for each company.

### Method
GET

### Endpoint
https://api.mantiks.io/company/search

### Parameters
#### Query Parameters
- **job_age_in_days** (integer) - Required - Maximum age in days since the job has been published.
- **job_location_ids** (array of integers) - Required - One or many IDs of locations to filter jobs. See location endpoint.
- **job_title** (array of strings) - Optional - One or many keywords to filter job titles.
- **job_title_include_all** (boolean) - Optional - Controls the boolean query behavior for `job_title`. `False` (default) uses OR, `True` uses AND.
- **job_title_excluded** (array of strings) - Optional - One or many keywords to exclude from job titles.
- **job_description** (array of strings) - Optional - One or many keywords to filter job descriptions.
- **job_description_include_all** (boolean) - Optional - Controls the boolean query behavior for `job_description`. `False` (default) uses OR, `True` uses AND.
- **job_description_excluded** (array of strings) - Optional - One or many keywords to exclude from job descriptions.
- **job_board** (string) - Optional - Enum: `indeed`, `linkedin`, `wttj`, `glassdoor`. Select jobs from a specific job board. Empty by default (all job boards enabled).
- **nb_min_job_posted** (integer) - Optional - Filter companies based on the minimum number of jobs posted matching the other targeting criteria.
- **nb_max_job_posted** (integer) - Optional - Filter companies based on the maximum number of jobs posted matching the other targeting criteria.
- **min_company_size** (integer) - Optional - Filter companies based on the number of employees.
- **max_company_size** (integer) - Optional - Filter companies based on the number of employees.
- **company_industry** (array of strings) - Optional - Filter companies based on their industry. Refer to Reference > Industry reference.
- **company_industry_excluded** (array of strings) - Optional - Filter companies by excluding a list of industries. Defaults to `["recruiting", "consulting"]`.
- **company_funding** (boolean) - Optional - Filter companies based on their fundings. Defaults to `false`.
- **limit** (integer) - Optional - Limit the volume of results. Maximum 500. Defaults to 10.
- **offset** (string) - Optional - Used to paginate results. Use the `next_offset` value from the previous result.

### Request Example
```json
{
  "example": "GET https://api.mantiks.io/company/search?job_location_ids=[1,2]&job_title=developer&limit=10&offset=some_offset_value"
}
```

### Response
#### Success Response (200)
- **companies** (array) - List of companies matching the criteria.
  - **company_id** (string) - The unique identifier for the company.
  - **company_name** (string) - The name of the company.
  - **jobs** (array) - List of jobs associated with the company.
    - **job_id** (string) - The unique identifier for the job.
    - **job_title** (string) - The title of the job.
    - **job_posted_date** (string) - The date the job was posted.
  - **next_offset** (string) - The offset for the next page of results.

#### Response Example
```json
{
  "companies": [
    {
      "company_id": "comp_123",
      "company_name": "Tech Solutions Inc.",
      "jobs": [
        {
          "job_id": "job_abc",
          "job_title": "Software Developer",
          "job_posted_date": "2023-10-27T10:00:00Z"
        }
      ]
    }
  ],
  "next_offset": "another_offset_value"
}
```

#### Error Response (400)
- **error** (string) - Description of the error.

#### Error Response (401)
- **error** (string) - Description of the error (e.g., authentication issue).
```

--------------------------------

### GET /jobs

Source: https://mantiks-api.readme.io/reference/enrich

Find company job postings. This endpoint allows you to get job postings for a given company.

```APIDOC
## GET /jobs

### Description
This endpoint allows you to get job postings for a given company.

### Method
GET

### Endpoint
https://api.mantiks.io/company/jobs

### Parameters
#### Query Parameters
- **linkedin_url** (string) - Optional - Company LinkedIn URL
- **website** (string) - Required - Company website URL
- **age_in_days** (integer) - Optional - Maximum age in days since the job has been published
- **keyword** (array of strings) - Optional - One or many keywords to filter job title
- **keyword_include_all** (boolean) - Optional - Control the behavior of the boolean query on keyword. False (default) = OR behavior, True = AND behavior
- **keyword_excluded** (array of strings) - Optional - One or many keywords to exclude from job title
- **keyword_description** (array of strings) - Optional - One or many keywords to filter job description
- **keyword_description_include_all** (boolean) - Optional - Control the behavior of the boolean query on keyword_description. False (default) = OR behavior, True = AND behavior
- **keyword_description_excluded** (array of strings) - Optional - One or many keywords to exclude from job description
- **location_ids** (array of integers) - Optional - One or many ids of location to filter job. See location endpoint
- **offset** (integer) - Optional - paginate parameter. Current response give next offset.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **example** (object) - Description of the response body structure

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /company/search

Source: https://mantiks-api.readme.io/reference/getting-started-with-your-api-1

Retrieves a list of companies and their associated job postings based on search criteria. This endpoint allows you to find companies and the jobs they are hiring for.

```APIDOC
## GET /company/search

### Description
Retrieves a list of companies and their associated job postings. This endpoint is useful for discovering companies and the jobs they are hiring for.

### Method
GET

### Endpoint
https://api.mantiks.io/company/search

### Parameters
#### Query Parameters
- **query** (string) - Optional - The search query for companies or job titles.
- **location** (string) - Optional - The location to filter companies and jobs by.

### Request Example
```bash
curl --request GET \
     --url "https://api.mantiks.io/company/search?query=software%20engineer&location=remote" \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **companies** (array) - A list of company objects, each containing company details and a list of job postings.
  - **id** (string) - The unique identifier for the company.
  - **name** (string) - The name of the company.
  - **min_company_size** (integer) - The minimum number of employees in the company.
  - **max_company_size** (integer) - The maximum number of employees in the company.
  - **website** (string) - The company's website URL.
  - **social_urls** (object) - Social media links for the company.
    - **facebook** (string) - Facebook page URL.
    - **linkedin** (string) - LinkedIn page URL.
  - **jobs** (array) - A list of job postings associated with the company.
    - **job_id** (string) - The unique identifier for the job.
    - **job_title** (string) - The title of the job.
    - **description** (string) - A brief description of the job.
    - **job_board** (string) - The job board where the listing was found (e.g., 'linkedin').
    - **job_board_id** (integer) - The ID of the job on the specific job board.
    - **job_board_url** (string) - The URL of the job listing on the job board.
    - **date_creation** (string) - The date the job was created (ISO 8601 format).
    - **last_seen** (string) - The last time the job posting was seen (ISO 8601 format).
    - **location** (string) - The location of the job.
    - **salary** (object) - Salary information for the job.
      - **min** (integer) - The minimum salary offered.
      - **max** (integer) - The maximum salary offered.
      - **type** (string) - The salary type (e.g., 'YEARLY').
    - **job_seniority** (string) - The seniority level of the job (e.g., 'Mid-Senior level').
    - **job_type** (string) - The type of employment (e.g., 'Full-time').
    - **sectors** (array) - A list of industry sectors for the job.
    - **indeed_easy_apply** (boolean) - Indicates if easy apply is available on Indeed.
    - **indeed_apply_url** (string) - The URL for applying easily on Indeed.
    - **linkedin_recruiter_name** (string) - The name of the recruiter on LinkedIn.
    - **linkedin_recruiter_title** (string) - The title of the recruiter on LinkedIn.
    - **linkedin_recruiter_link** (string) - The link to the recruiter's profile on LinkedIn.
    - **linkedin_apply_url** (string) - The URL for applying via LinkedIn.

#### Response Example
```json
{
  "companies": [
    {
      "id": "93354b80-a141-470d-8961-fcd4efbc2fbb",
      "jobs": [
        {
          "date_creation": "2024-11-13T20:28:33.074005",
          "description": "...",
          "job_board": "linkedin",
          "job_board_id": 4075138266,
          "job_board_url": "https://www.linkedin.com/jobs/view/4075138266",
          "job_id": "a1552ed8-9027-4ea2-9a39-06e7d1320639",
          "job_title": "Manager de production F/H",
          "last_seen": "2024-11-15T06:59:00.212556",
          "location": "Bourg-lès-Valence, Auvergne-Rhône-Alpes, France",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
          },
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://..."
        }
      ],
      "max_company_size": 50,
      "min_company_size": 11,
      "name": "bellonandfils",
      "social_urls": {
        "facebook": "https://www.facebook.com/BellonFils",
        "linkedin": "https://www.linkedin.com/company/bellon-fils"
      },
      "website": "https://bellon.fr"
    }
  ]
}
```

#### Error Response (403)
- **Error**: Indicates forbidden access, likely due to missing or invalid credentials.
```

--------------------------------

### GET /companies

Source: https://mantiks-api.readme.io/reference/search

Retrieves a list of companies with associated job postings. This endpoint allows filtering by various criteria to narrow down the search results.

```APIDOC
## GET /companies

### Description
Retrieves a list of companies with associated job postings. This endpoint allows filtering by various criteria to narrow down the search results.

### Method
GET

### Endpoint
/companies

### Parameters
#### Query Parameters
- **industry** (string) - Optional - Filter companies by industry.
- **job_board_id** (integer) - Optional - Filter companies by a specific job board ID.
- **job_location_ids** (string) - Optional - Filter companies by location IDs. Comma-separated list of IDs.
- **company_size_min** (integer) - Optional - Filter companies by minimum size.
- **company_size_max** (integer) - Optional - Filter companies by maximum size.
- **offset** (string) - Optional - For pagination, specifies the starting point for the next set of results.
- **limit** (integer) - Optional - For pagination, specifies the maximum number of results to return.

### Request Example
```
GET /companies?industry=Technology&limit=10
```

### Response
#### Success Response (200)
- **companies** (array) - An array of company objects, each containing details like name, website, social URLs, and a list of jobs.
- **credits_cost** (integer) - The cost in credits for this API call.
- **credits_remaining** (integer) - The number of credits remaining.
- **nb_companies** (integer) - The total number of companies returned.
- **nb_jobs** (integer) - The total number of jobs across the returned companies.
- **next_offset** (string) - An offset token for fetching the next page of results.

#### Response Example
```json
{
  "companies": [
    {
      "name": "melvinandahamiltondigital",
      "website": "http://www.melvin-hamilton.com",
      "social_urls": {
        "facebook": "https://www.facebook.com/Melvin.and.Hamilton",
        "linkedin": "https://www.linkedin.com/company/melvin-&-hamilton-digital/",
        "twitter": "https://twitter.com/MelvinHamilton"
      },
      "min_company_size": 11,
      "max_company_size": 50,
      "jobs": [
        {
          "job_id": "e5ef694f-09cf-4dd2-b67f-eb497b80ad79",
          "job_title": "Product & Merchandising Manager",
          "description": "...",
          "job_board": "linkedin",
          "job_board_id": 4075550083,
          "job_board_url": "https://www.linkedin.com/jobs/view/4075550083",
          "job_location": "Paris, Île-de-France, France",
          "salary": {
            "min": 125000,
            "max": 135000,
            "type": "YEARLY"
          },
          "job_seniority": "Mid-Senior level",
          "job_type": "Full-time",
          "sectors": ["Airlines and Aviation"],
          "indeed_easy_apply": true,
          "indeed_apply_url": "https://...",
          "linkedin_recruiter_name": "John",
          "linkedin_recruiter_title": "Doh",
          "linkedin_recruiter_link": "Manager",
          "linkedin_apply_url": "https://...",
          "date_creation": "2024-11-13T16:45:35.885895",
          "last_seen": "2024-11-15T01:16:15.646267"
        }
      ]
    }
  ],
  "credits_cost": 3,
  "credits_remaining": 4556,
  "nb_companies": 3,
  "nb_jobs": 3,
  "next_offset": "abc"
}
```

#### Error Responses
- **400 Bad Request**: Returned if query parameters are invalid (e.g., missing required parameters, incorrect format).
  - Example: `{"error": "invalid 'job_location_ids' param. param is required"}`
  - Example: `{"error": "invalid industry 'xxxxx' does not exist"}`
- **401 Unauthorized**: Returned if the API key is invalid or missing.
  - Example: `{"error": "Bad API Key"}`
- **403 Forbidden**: Returned if the user does not have sufficient credits.
  - Example: `{"error": "Not enough credits : xx"}`
```

--------------------------------

### Location Search Endpoint OpenAPI Definition

Source: https://mantiks-api.readme.io/reference/location-endpoint

The OpenAPI 3.1.0 definition for the Mantiks API's location search endpoint. This definition specifies the API's structure, including server URLs, security schemes, and the parameters and responses for the `/location/search` GET request. It details how to query for location IDs and the format of the returned data.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Mantiks API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.mantiks.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "x-default": "",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/location/search": {
      "get": {
        "summary": "Location endpoint",
        "description": "This endpoint allows you to get the location ids related to a given location.",
        "operationId": "location-endpoint",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "description": "location to search for",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "path",
            "description": "location for which you want the location id",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"nb_results\": 15,\n\t\"results\": [\n\t\t{\n\t\t\t\"country\": \"France\",\n\t\t\t\"full_name\": \"Paris - Île-de-France - France\",\n\t\t\t\"id\": 2988507,\n\t\t\t\"name\": \"Paris\",\n\t\t\t\"type\": \"city\"\n\t\t},\n\t\t{\n\t\t\t\"country\": \"France\",\n\t\t\t\"full_name\": \"Paris - France\",\n\t\t\t\"id\": 2968815,\n\t\t\t\"name\": \"Paris\",\n\t\t\t\"type\": \"region\"\n\t\t},\n\t\t{\n\t\t\t\"country\": \"United States\",\n\t\t\t\"full_name\": \"Jefferson Parish - United States\",\n\t\t\t\"id\": 4328978,\n\t\t\t\"name\": \"Jefferson Parish\",\n\t\t\t\"type\": \"region\"\n\t\t}\n...\n    ]\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "673459040dbafd0073998f2e:673467c9c7fa49002a119e91"
}
```

--------------------------------

### Limit and Paginate Company Results

Source: https://mantiks-api.readme.io/reference/search

These query parameters control the number of results returned and enable pagination. 'limit' sets the maximum number of results (up to 500), and 'offset' is used with 'next_offset' from a previous response to fetch subsequent pages.

```json
{
  "name": "limit",
  "in": "query",
  "description": "Limit the volume of results in the answer. Maximum 500",
  "schema": {
    "type": "integer",
    "format": "int32",
    "default": 10
  }
}
```

```json
{
  "name": "offset",
  "in": "query",
  "description": "Use to paginate results. Use \"next_offset\" from previous result to get the next page",
  "schema": {
    "type": "string"
  }
}
```

--------------------------------

### Authenticate API Requests using cURL

Source: https://mantiks-api.readme.io/reference/authentication

Demonstrates how to include the required 'x-api-key' header in a cURL request to the Mantiks API. Replace 'YOUR_API_KEY' with your actual key generated from the account profile page.

```curl
curl --request GET \
     --url https://api.mantiks.io/EX_ENDPOINT \
     --header 'accept: application/json' \
     --header 'x-api-key: YOUR_API_KEY'
```
Tokens:
Raw