Job endpoints

Browse jobs, apply, and run the hiring pipeline for jobs you posted.

All paths are relative to https://urnextdoor.com/api/v1. See API reference for the envelope and headers every endpoint shares.

Endpoint	What it does	Scope	Daily quota
`GET /jobs`	Browse jobs	`browse`	not counted
`GET /jobs/{slug}`	Read a job	`browse`	not counted
`POST /jobs/{id}/close`	Close your job post	`edit`	`edit`
`POST /jobs/{id}/reopen`	Reopen your job post	`edit`	`edit`
`GET /jobs/{id}/applications`	List applicants for your job	`marketplace`	not counted
`POST /jobs/{id}/applications`	Apply to a job	`marketplace`	`apply`
`GET /applications`	List applications	`marketplace`	not counted
`POST /applications/{id}/withdraw`	Withdraw your application	`marketplace`	not counted
`POST /applications/{id}/review`	Mark an application under review	`marketplace`	not counted
`POST /applications/{id}/shortlist`	Shortlist an application	`marketplace`	not counted
`POST /applications/{id}/interview`	Move an application to interview	`marketplace`	not counted
`POST /applications/{id}/offer`	Make an offer	`marketplace`	not counted
`POST /applications/{id}/hire`	Hire an applicant	`marketplace`	not counted
`POST /applications/{id}/reject`	Reject an application	`marketplace`	not counted

Browse jobs

GET https://urnextdoor.com/api/v1/jobs

Open jobs.

Auth: your API key (Bearer or X-API-Key)
Scope: browse
Daily quota: not counted
operationId: listJobs

Parameters

Name	In	Required	Description
`type`	query	No	An employment type from GET /job-options.
`mode`	query	No	A work mode from GET /job-options.
`experience`	query	No	An experience level from GET /job-options.
`location`	query	No	A city.
`salary_min`	query	No	Lowest salary.
`offset`	query	No	Start of the page.
`limit`	query	No	Items per page (default 12).

Example

cURL

curl "https://urnextdoor.com/api/v1/jobs" \
  -H "Authorization: Bearer $UND_API_KEY"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs", {
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.get(
    "https://urnextdoor.com/api/v1/jobs",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/jobs');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	A page of jobs.
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Read a job

GET https://urnextdoor.com/api/v1/jobs/{slug}

A job post, by id or slug, with your application if you applied.

Auth: your API key (Bearer or X-API-Key)
Scope: browse
Daily quota: not counted
operationId: getJob

Parameters

Name	In	Required	Description
`slug`	path	Yes	The job slug or id.

Example

cURL

curl "https://urnextdoor.com/api/v1/jobs/rooftop-growers" \
  -H "Authorization: Bearer $UND_API_KEY"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs/rooftop-growers", {
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.get(
    "https://urnextdoor.com/api/v1/jobs/rooftop-growers",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/jobs/rooftop-growers');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{item, my_application, can_apply, cv_missing}.
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Close your job post

POST https://urnextdoor.com/api/v1/jobs/{id}/close

Stop taking applications.

Auth: your API key (Bearer or X-API-Key)
Scope: edit
Daily quota: counts as edit (see limits)
Idempotency-Key: supported (see Idempotency)
operationId: closeJob

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/jobs/41/close" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs/41/close", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/jobs/41/close",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/jobs/41/close');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, item}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Reopen your job post

POST https://urnextdoor.com/api/v1/jobs/{id}/reopen

Take applications again.

Auth: your API key (Bearer or X-API-Key)
Scope: edit
Daily quota: counts as edit (see limits)
Idempotency-Key: supported (see Idempotency)
operationId: reopenJob

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/jobs/41/reopen" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs/41/reopen", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/jobs/41/reopen",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/jobs/41/reopen');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, item}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

List applicants for your job

GET https://urnextdoor.com/api/v1/jobs/{id}/applications

Everyone who applied to one of your job posts.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
operationId: listApplicants

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.
`status`	query	No	Only applications in this status.

Example

cURL

curl "https://urnextdoor.com/api/v1/jobs/41/applications" \
  -H "Authorization: Bearer $UND_API_KEY"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs/41/applications", {
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.get(
    "https://urnextdoor.com/api/v1/jobs/41/applications",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/jobs/41/applications');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{items, job, counts}.
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Apply to a job

POST https://urnextdoor.com/api/v1/jobs/{id}/applications

Apply with your CV and an optional note. Needs a CV (Settings > CV); without one the answer is 422 cv_missing.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: counts as apply (see limits)
Idempotency-Key: supported (see Idempotency)
operationId: applyToJob

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Request body

Send Content-Type: application/json.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/jobs/41/applications" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "cover_note": "I have looked after rooftop gardens for three years."
}'

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/jobs/41/applications", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    cover_note: "I have looked after rooftop gardens for three years.",
  }),
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/jobs/41/applications",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "cover_note": "I have looked after rooftop gardens for three years.",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$payload = [
    'cover_note' => 'I have looked after rooftop gardens for three years.',
];

$ch = curl_init('https://urnextdoor.com/api/v1/jobs/41/applications');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
    CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`201 Created`	{id, status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

List applications

GET https://urnextdoor.com/api/v1/applications

Applications you sent, or received for your jobs.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
operationId: listApplications

Parameters

Name	In	Required	Description
`tab`	query	No	applied or received.
`offset`	query	No	Start of the page.
`limit`	query	No	Items per page (default 20).

Example

cURL

curl "https://urnextdoor.com/api/v1/applications" \
  -H "Authorization: Bearer $UND_API_KEY"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications", {
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.get(
    "https://urnextdoor.com/api/v1/applications",
    headers={
        "Authorization": f"Bearer {api_key}",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	A page of applications, with counts.
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Withdraw your application

POST https://urnextdoor.com/api/v1/applications/{id}/withdraw

Take back an application you sent.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: withdrawApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/withdraw" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/withdraw", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/withdraw",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/withdraw');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Mark an application under review

POST https://urnextdoor.com/api/v1/applications/{id}/review

Move an application to your job to under review. The applicant is told.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: reviewApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/review" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/review", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/review",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/review');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Shortlist an application

POST https://urnextdoor.com/api/v1/applications/{id}/shortlist

Shortlist an applicant to your job.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: shortlistApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/shortlist" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/shortlist", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/shortlist",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/shortlist');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Move an application to interview

POST https://urnextdoor.com/api/v1/applications/{id}/interview

Mark an applicant to your job as interviewing.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: interviewApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/interview" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/interview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/interview",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/interview');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Make an offer

POST https://urnextdoor.com/api/v1/applications/{id}/offer

Mark an applicant to your job as offered.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: offerApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/offer" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/offer", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/offer",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/offer');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Hire an applicant

POST https://urnextdoor.com/api/v1/applications/{id}/hire

Mark an applicant to your job as hired.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: hireApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/hire" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/hire", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/hire",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/hire');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Reject an application

POST https://urnextdoor.com/api/v1/applications/{id}/reject

Reject an applicant to your job, with an optional note.

Auth: your API key (Bearer or X-API-Key)
Scope: marketplace
Daily quota: not counted
Idempotency-Key: supported (see Idempotency)
operationId: rejectApplication

Parameters

Name	In	Required	Description
`id`	path	Yes	The numeric id of the item.

Request body

Send Content-Type: application/json.

Example

cURL

curl -X POST "https://urnextdoor.com/api/v1/applications/41/reject" \
  -H "Authorization: Bearer $UND_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "recruiter_note": "We chose a candidate nearer the site."
}'

JavaScript

const res = await fetch("https://urnextdoor.com/api/v1/applications/41/reject", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UND_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    recruiter_note: "We chose a candidate nearer the site.",
  }),
});
console.log(res.status, await res.json());

Python

import os
import uuid

import requests

api_key = os.environ["UND_API_KEY"]

response = requests.post(
    "https://urnextdoor.com/api/v1/applications/41/reject",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "recruiter_note": "We chose a candidate nearer the site.",
    },
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php
$apiKey = getenv('UND_API_KEY');

$payload = [
    'recruiter_note' => 'We chose a candidate nearer the site.',
];

$ch = curl_init('https://urnextdoor.com/api/v1/applications/41/reject');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
    CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

echo $status, PHP_EOL, $body, PHP_EOL;

Responses

Status	Meaning	Codes
`200 OK`	{status, application}.
`400 Bad Request`	The body is not a JSON object, or the Idempotency-Key header is malformed.	`invalid_json`, `invalid_idempotency_key`
`401 Unauthorized`	No key, or the key is unknown, malformed, revoked or expired, or the member is not active.	`missing_api_key`, `invalid_api_key`
`403 Forbidden`	The key lacks the scope, or the member may not do this.	`insufficient_scope`, `forbidden`
`404 Not Found`	Unknown route or item, or the item is not yours.	`not_found`
`409 Conflict`	Conflicts with the current state, or the same Idempotency-Key is still being processed.	`conflict`, `idempotency_in_progress`
`413 Payload Too Large`	The body is over the limit, or the image is over 8 MB.	`payload_too_large`
`415 Unsupported Media Type`	Wrong Content-Type, or a file type that is not allowed.	`unsupported_media_type`
`421 Misdirected Request`	Called on a community subdomain. Use https://urnextdoor.com.	`wrong_host`
`422 Unprocessable Content`	Field errors, or an Idempotency-Key reused with a different body.	`validation_failed`, `idempotency_key_reused`
`429 Too Many Requests`	Over 60 requests a minute from this member (or too many failed key checks from one address), or today's quota for this action is used up.	`rate_limited`, `quota_exceeded`
`500 Internal Server Error`	Our fault. Safe to retry with the same Idempotency-Key.	`server_error`
`503 Service Unavailable`	The API is switched off.	`api_disabled`

Last updated October 16, 2026