# GetMattered API (/docs)

Apply to jobs by API and know when the employer confirmed each one. Then score, parse and tailor resumes and write cover letters.

The GetMattered API gives your code the engine that lands GetMattered users their interviews.
Send a job link, and GetMattered fills the employer's form from your account, sends it and tells you when the employer confirmed it.
The resume calls score, parse and tailor a resume, and write the cover letter, for any posting.

## Make your first call [#make-your-first-call]

1. [Create a key](https://getmattered.com/dashboard/developers) in the dashboard. It starts with `gm_live_`, and your first key brings 100,000 free API tokens.
2. Keep it on your server: `export GETMATTERED_API_KEY="gm_live_..."`.
3. Send one request. This one scores a resume against a job posting.

```bash tab="curl"
curl https://api.getmattered.com/api/v1/developer/ats-score \
  -H "Authorization: Bearer $GETMATTERED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resumeText": "Jane Doe. Senior Software Engineer. 6 years building React and TypeScript apps at Acme.",
    "jobDescription": "We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience."
  }'
```

```js tab="JavaScript"
// npm i getmattered
import { GetMattered } from 'getmattered';

const client = new GetMattered({ apiKey: process.env.GETMATTERED_API_KEY });
const data = await client.tools.atsScore({
  resumeText: 'Jane Doe. Senior Software Engineer. 6 years building React and TypeScript apps at Acme.',
  jobDescription: 'We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience.',
});
console.log(data.overallScore, data.missingKeywords);
```

```python tab="Python"
import os
import requests

response = requests.post(
    "https://api.getmattered.com/api/v1/developer/ats-score",
    headers={"Authorization": f"Bearer {os.environ['GETMATTERED_API_KEY']}"},
    json={
        "resumeText": "Jane Doe. Senior Software Engineer. 6 years building React and TypeScript apps at Acme.",
        "jobDescription": "We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience.",
    },
)
data = response.json()["data"]
print(data["overallScore"], data["missingKeywords"])
```

The JavaScript tab uses the official SDK: install it with `npm i getmattered`, and see [SDKs](/docs/sdks).
The answer comes back as JSON, with the result in `data` and the tokens the call spent in `data.usage.tokens`.
Every request and response body is JSON, and the base URL is `https://api.getmattered.com/api/v1`.
The [Quickstart](/docs/quickstart) goes on to send your first application.

## Browse by resource [#browse-by-resource]

### Candidate

Read and update the job seeker: profile, resume and what they are looking for.

- [`GET /developer/profile`](/docs/reference/profile-get): Read the candidate profile
- [`PATCH /developer/profile`](/docs/reference/profile): Update the candidate profile
- [`GET /developer/resume`](/docs/reference/resume-get): Read the resume
- [`POST /developer/resume`](/docs/reference/resume): Upload a resume
- [`GET /developer/preferences`](/docs/reference/preferences-get): Read job preferences
- [`PUT /developer/preferences`](/docs/reference/preferences): Save job preferences

### Jobs

Search jobs and read the matches GetMattered found for the candidate.

- [`GET /developer/jobs/{id}`](/docs/reference/jobs-id): Read a job
- [`GET /developer/jobs/matches`](/docs/reference/jobs/matches): List the candidate's matches
- [`GET /developer/jobs/search`](/docs/reference/jobs/search): Search jobs

### Applications

Apply to a job by link, then read when the employer confirmed it. Guide: [Apply to a job by API](/docs/guides/apply-to-a-job).

- [`POST /developer/apply`](/docs/reference/apply): Apply to a job posting
- [`GET /developer/applications`](/docs/reference/applications): List applications
- [`GET /developer/applications/{id}`](/docs/reference/applications-id): Read an application
- [`POST /developer/applications/{id}/approve`](/docs/reference/applications-id/approve): Approve a held application
- [`POST /developer/applications/{id}/cancel`](/docs/reference/applications-id/cancel): Cancel an application

### Resume tools

Score, parse and tailor a resume, analyze a posting and write a cover letter. Guide: [Score a resume against a job post](/docs/guides/score-resume-against-job).

- [`POST /developer/ats-score`](/docs/reference/ats-score): Score a resume for ATS compatibility
- [`POST /developer/parse`](/docs/reference/parse): Parse a resume into structured fields
- [`POST /developer/analyze-job`](/docs/reference/analyze-job): Analyze a job posting
- [`POST /developer/tailor`](/docs/reference/tailor): Tailor a resume to a job posting
- [`POST /developer/cv-pack`](/docs/reference/cv-pack): Parse, score and tailor a resume in one call
- [`POST /developer/cover-letter`](/docs/reference/cover-letter): Write a cover letter

### Webhooks

Get a signed event when an application changes, instead of polling. Guide: [Receive webhooks](/docs/guides/receive-webhooks).

- [`GET /developer/webhooks`](/docs/reference/webhooks-get): List webhook endpoints
- [`POST /developer/webhooks`](/docs/reference/webhooks): Add a webhook endpoint
- [`DELETE /developer/webhooks/{id}`](/docs/reference/webhooks-id): Delete a webhook endpoint
- [`GET /developer/webhooks/{id}/deliveries`](/docs/reference/webhooks-id/deliveries): Read webhook deliveries
- [`POST /developer/webhooks/{id}/test`](/docs/reference/webhooks-id/test): Send a test event

### Billing

Read your API balance and what each month of calls spent. Guide: [Pricing](/docs/pricing).

- [`GET /developer/balance`](/docs/reference/balance): Read your API balance
- [`GET /developer/usage`](/docs/reference/usage): Read your monthly usage

The [API reference](/docs/reference/apply) lists every endpoint with its full request and response schema, code in curl, JavaScript and Python, and a playground that sends a real request with your key.
The OpenAPI 3.1 document is at [`/docs/openapi.json`](/docs/openapi.json).

## Before you go live [#before-you-go-live]

1. [Authentication](/docs/authentication): how to send the key, and how to revoke it.
2. [Pricing](/docs/pricing): API calls spend prepaid API tokens, apart from the app plans.
3. [Rate limits](/docs/rate-limits): how many calls a key can make.
4. [Errors](/docs/errors): the error format and the codes.
5. [Data and privacy](/docs/data-and-privacy): what we keep from each call.

## Guides [#guides]

- [Apply to a job by API](/docs/guides/apply-to-a-job): send a job link, then read when the employer confirmed it.
- [Parse a resume to JSON](/docs/guides/parse-resume-to-json): contact details, work history, education and skills, with the resume line behind each contact fact.
- [Score a resume against a job post](/docs/guides/score-resume-against-job): the match, the missing keywords and the fixes, then a tailored resume in one more call.
- [Receive webhooks](/docs/guides/receive-webhooks): get a signed event when an application changes, and verify it in JavaScript or Python.

## Run your job search from an AI assistant [#run-your-job-search-from-an-ai-assistant]

The GetMattered MCP server runs the same apply engine from the AI assistant you already use.
You ask for jobs in plain words, and it applies for you.
Set it up at [getmattered.com/mcps](https://getmattered.com/mcps).

## For AI agents [#for-ai-agents]

- [`/docs/llms.txt`](/docs/llms.txt) lists every page with a link to its Markdown.
- [`/docs/llms-full.txt`](/docs/llms-full.txt) holds every page in one file.
- Add `.md` to any page URL to get that page as Markdown, for example [`/docs/quickstart.md`](/docs/quickstart.md).
- An MCP server for these docs runs at `https://getmattered.com/docs/mcp` (Streamable HTTP). Its tools list, read and search the pages.

These docs are in English.