> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.vouch.careers/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vouch.careers/_mcp/server. # Get a position GET https://vouch.careers/api/v1/positions/{id} Reference: https://docs.vouch.careers/api-reference/positions/get-position ## Authentication - `Authorization` header (bearer token, required) — API key created in company settings, sent as `Authorization: Bearer `. ## Request ### Path parameters - `id` (string, required) — The position ID. ## Response ### 200 Position detail. - `data` (PositionDetail, required) ## Errors ### 401 Unauthorized Error Missing or invalid API key. - `error` (string, required) - `code` (string, required) ### 403 Forbidden Error API key does not have access to the requested company or position's data. - `error` (string, required) - `code` (string, required) ### 404 Not Found Error Position not found. - `error` (string, required) - `code` (string, required) ### 429 Too Many Requests Error Rate limit exceeded. See the Retry-After header for when to retry. - `error` (string, required) - `code` (string, required) ## Types ### PositionDetail - `id` (string, required) - `title` (string, required) - `pitch` (string, required, nullable) — One-paragraph pitch/summary for the position — also woven into the opening of contentHtml (on the detail endpoint), not just this field. - `status` (enum, required) — Publish lifecycle status — derived automatically from publish/pause/archive actions and whether the position currently has any live, reachable link (an active sharing link or careers page listing), never set directly. 'DRAFT': never published. 'PUBLISHED': published and currently reachable via at least one active link. 'ACTIVE': published and not paused, but not currently reachable via any active link right now (e.g. every link on it is temporarily inactive). 'PAUSED': published and explicitly paused, not currently reachable. 'ARCHIVED': closed (archived or deleted). - Allowed values: `DRAFT`, `PUBLISHED`, `ACTIVE`, `PAUSED`, `ARCHIVED` - `language` (enum, required) - Allowed values: `NO`, `DK`, `EN`, `SE`, `GB` - `employmentType` (list of enum, required) — Employment type tags for this position (e.g. Full-time, Remote, Internship). - Allowed values: `Full-time`, `Part-time`, `On-site`, `Temporary`, `Internship`, `Volunteer`, `Contract`, `Remote`, `Hybrid` - `listingColor` (string, required, nullable) - `bannerUrl` (string, required, nullable) - `locations` (list of Location, required) - `createdAt` (datetime, required) - `updatedAt` (datetime, required) - `publishedAt` (datetime, required, nullable) - `lastPublishedAt` (datetime, required, nullable) - `firstActivatedAt` (datetime, required, nullable) - `expirationDate` (datetime, required, nullable) - `enableApplication` (boolean, required) - `enableVouch` (boolean, required) - `company` (Company, required) - `highlights` (list of string, required, nullable) - `salary` (PositionDetailSalary, required, nullable) - `contentHtml` (string, required) — The position's text-only description as HTML (job-board tag subset). This is what job boards receive: a manually edited text when the position has one, otherwise the text derived from its sections. - `contentHtmlDefault` (string, required) — The text derived from the position's sections, regardless of any manual edit. - `contentHtmlOverride` (string, required, nullable) — The manually edited text, or null when contentHtml is the derived default. - `images` (list of list of string, required) — This position's image gallery sections — contentHtml doesn't include these (a photo gallery has no inline-HTML equivalent), so they're surfaced separately here. One array per image gallery section (in section order), each holding that section's image URLs (in image order), fully resolved and ready to use directly. - `sharingLinks` (list of SharingLink, required) — Active direct channels for this position (job boards, ads, referral networks). Use these to link candidates to apply/refer, or to embed the Vouch widget. See the Embedded Widget guide. - `careerPagesLinks` (list of CareerPageLink, required) — Active company careers pages this position is listed on. ### Location - `id` (string, required) - `address` (string, required) - `city` (string, required) - `country` (string, required) - `locality` (string, required, nullable) - `postalCode` (string, required, nullable) - `administrativeArea` (string, required, nullable) - `subAdministrativeArea` (string, required, nullable) - `lat` (double, required) - `lng` (double, required) ### Company - `id` (string, required) - `name` (string, required) - `slug` (string, required) - `website` (string, required) - `logoUrl` (string, required, nullable) - `industries` (list of enum, required) - Allowed values: `AKVAKULTUR`, `HAVBRUK`, `FISKERI`, `EMPLOYER_EMPLOYEE_ORGANIZATIONS`, `ARCHITECTURE_AREA`, `ARCHIVE_LIBRARY`, `BANK`, `CHILD_SCHOOL_EDUCATION`, `CAR_VEHICLE_WORKSHOP`, `CAR_PARTS_MANUFACTURING`, `STORE_RETAIL`, `CONSTRUCTION`, `MAINTENANCE_SERVICES`, `ANIMALS_ANIMAL_HEALTH`, `REAL_ESTATE`, `ELECTRONICS`, `EVENTS`, `PHARMACEUTICAL_MEDICINE`, `FINANCE`, `PUBLISHING_PRINTING`, `INSURANCE`, `RESEARCH_EDUCATION_SCIENCE`, `WHOLESALE_IMPORT_EXPORT`, `HR`, `HEALTHCARE`, `HOTEL_ACCOMMODATION`, `INFORMATION_TECHNOLOGY`, `NON_PROFIT_ORGANIZATIONS`, `SPORTS_TRAINING`, `INDUSTRY_MANUFACTURING`, `ONLINE_SERVICES`, `LEGAL_SERVICES`, `CHEMICAL_INDUSTRY`, `CONSULTING_ADVISORY`, `POWER_ENERGY`, `ART_CULTURE`, `AVIATION`, `MARITIME_OFFSHORE`, `MARKET_ANALYSIS`, `MARKETING_ADVERTISING`, `FOOD_PRODUCTION_INDUSTRY`, `MEDIA_CONTENT_PRODUCTION`, `MEDICAL_EQUIPMENT_SUPPLIES`, `ENVIRONMENTAL_SERVICES`, `MUSEUMS_GALLERIES_CULTURAL_HERITAGE`, `MUSIC`, `PUBLIC_ADMINISTRATION`, `OIL_GAS`, `ORGANIZATIONS`, `ORGANIZATION_DEVELOPMENT`, `PR_INFORMATION_COMMUNICATION`, `POLICE_SECURITY`, `TRAVEL_TOURISM`, `RECRUITMENT`, `WASTE_CLEANING`, `RESTAURANT_FOOD_NIGHTLIFE`, `SHIPPING`, `TELECOMMUNICATIONS`, `TRANSPORT_LOGISTICS`, `ENTERTAINMENT`, `ECONOMY_ACCOUNTING`, `VENTURE_CAPITAL`, `SOFTWARE_DEVELOPMENT`, `PRIVATE_EQUITY`, `OTHER`, `SPACE`, `GROUND_STATION` - `country` (string, required) - `language` (enum, required, nullable) - Allowed values: `NO`, `DK`, `EN`, `SE`, `GB` - `brandColor` (string, required, nullable) - `bannerUrl` (string, required, nullable) - `socialMediaLinks` (map from string to string, required) - `contentHtml` (string, required) — The company's text-only description as HTML (job-board tag subset). This is what job boards receive: a manually edited text when the company has one, otherwise the text derived from the company's sections. - `contentHtmlDefault` (string, required) — The text derived from the company sections, regardless of any manual edit. - `contentHtmlOverride` (string, required, nullable) — The manually edited text, or null when contentHtml is the derived default. - `locations` (list of Location, required) - `images` (list of list of string, required) — The company's image gallery sections — contentHtml doesn't include these (a photo gallery has no inline-HTML equivalent), so they're surfaced separately here. One array per image gallery section (in section order), each holding that section's image URLs (in image order), fully resolved and ready to use directly. ### PositionDetailSalary - `type` (string, required, nullable) - `currency` (enum, required, nullable) - Allowed values: `NOK`, `SEK`, `DKK`, `EUR`, `GBP`, `USD`, `CAD`, `AUD` - `minSalary` (double, required, nullable) - `maxSalary` (double, required, nullable) - `extra` (string, required, nullable) ### SharingLink - `id` (string, required) — The referral link ID backing this sharing link. - `idForEmbedded` (string, required) — The value to use for the embedded widget (iframe src / data-vouch-* attributes) — see the Embedded Widget guide. Same as `id` for a direct sharing link. - `type` (enum, required) — The kind of sharing link: a job board posting, an ad, a referral network, or other. - Allowed values: `JOB_BOARD`, `AD`, `NETWORK`, `OTHER` - `platform` (string, required) — Free-text platform label, e.g. 'THE_HUB', 'FINN', 'NAV', 'WEBSITE', 'EMPLOYEE', 'SOCIAL_MEDIA'. - `name` (string, required) - `jobUrl` (string, required) — Public job position page for this sharing link. - `applyUrl` (string, required) — Direct link to the application form for this sharing link. - `vouchUrl` (string, required) — Direct link to the referral (vouch) form for this sharing link. ### CareerPageLink - `id` (string, required) — The referral link ID backing this careers page. - `idForEmbedded` (string, required) — The value to use for the embedded widget (iframe src / data-vouch-\* attributes) — see the Embedded Widget guide. NOT the same as `id` — this is `.`, since a careers page embed needs to know which position to show. - `name` (string, required) - `forAgency` (boolean, required) — True if this careers page belongs to the agency itself (lists positions across all its clients), not one specific client. - `forClient` (boolean, required) — True if this careers page belongs specifically to the client this position is managed for. - `isDefault` (boolean, required) — True if this is the default careers page for its company. - `isMarketplace` (boolean, required) — True if this is the Vouch marketplace (vouch.careers) rather than a company careers page — modelled the same way, with the same URL shape. - `jobUrl` (string, required) — Public job position page on this careers page. - `applyUrl` (string, required) — Direct link to the application form via this careers page. - `vouchUrl` (string, required) — Direct link to the referral (vouch) form via this careers page. - `connectUrl` (string, required) — Direct link to the connect-with-company form for this careers page. Company-level (not position-specific) — the same URL applies across all positions on this page. ## Examples **Request** ```json {} ``` **Response** ```json { "data": { "id": "pos_9f8b7c6d5e4a3b2c1d0e", "title": "Senior Software Engineer", "pitch": "Join our dynamic team to build scalable web applications and innovate in cloud technologies.", "status": "ACTIVE", "language": "EN", "employmentType": [ "Full-time", "Remote", "Hybrid" ], "listingColor": "#0055cc", "bannerUrl": "https://cdn.vouch.careers/banners/pos_9f8b7c6d5e4a3b2c1d0e/banner.jpg", "locations": [ { "id": "loc_1234567890abcdef", "address": "123 Innovation Drive", "city": "Oslo", "country": "NO", "locality": "Oslo", "postalCode": "0150", "administrativeArea": "Oslo", "subAdministrativeArea": null, "lat": 59.9139, "lng": 10.7522 } ], "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-04-10T14:45:00Z", "publishedAt": "2024-02-01T08:00:00Z", "lastPublishedAt": "2024-04-01T12:00:00Z", "firstActivatedAt": "2024-02-01T08:00:00Z", "expirationDate": "2024-12-31T23:59:59Z", "enableApplication": true, "enableVouch": true, "company": { "id": "comp_abcdef1234567890", "name": "Nordic Tech Solutions", "slug": "nordic-tech-solutions", "website": "https://www.nordictechsolutions.com", "logoUrl": "https://cdn.nordictechsolutions.com/logo.png", "industries": [ "INFORMATION_TECHNOLOGY", "SOFTWARE_DEVELOPMENT" ], "country": "NO", "language": "EN", "brandColor": "#007a99", "bannerUrl": "https://cdn.nordictechsolutions.com/banner.jpg", "socialMediaLinks": { "linkedin": "https://linkedin.com/company/nordic-tech-solutions", "twitter": "https://twitter.com/nordictech" }, "contentHtml": "

Nordic Tech Solutions is a leading software development company specializing in cloud and AI technologies.

", "contentHtmlDefault": "

Leading software company in Scandinavia focused on innovation and quality.

", "contentHtmlOverride": null, "locations": [ { "id": "loc_comp_001", "address": "500 Tech Park", "city": "Oslo", "country": "NO", "locality": "Oslo", "postalCode": "0179", "administrativeArea": "Oslo", "subAdministrativeArea": null, "lat": 59.92, "lng": 10.75 } ], "images": [ [ "https://cdn.nordictechsolutions.com/images/office1.jpg", "https://cdn.nordictechsolutions.com/images/team.jpg" ] ] }, "highlights": [ "Flexible working hours", "Competitive salary and benefits", "Opportunity to work with cutting-edge technology" ], "salary": { "type": "Annual", "currency": "NOK", "minSalary": 650000, "maxSalary": 900000, "extra": "Includes bonus and stock options" }, "contentHtml": "

We are looking for a Senior Software Engineer to join our team. You will work on scalable web applications and cloud infrastructure.

", "contentHtmlDefault": "

Position involves software development, code reviews, and collaboration with cross-functional teams.

", "contentHtmlOverride": null, "images": [ [ "https://cdn.vouch.careers/positions/pos_9f8b7c6d5e4a3b2c1d0e/image1.jpg", "https://cdn.vouch.careers/positions/pos_9f8b7c6d5e4a3b2c1d0e/image2.jpg" ] ], "sharingLinks": [ { "id": "share_001", "idForEmbedded": "share_001", "type": "JOB_BOARD", "platform": "THE_HUB", "name": "The Hub Job Posting", "jobUrl": "https://thehub.no/jobs/pos_9f8b7c6d5e4a3b2c1d0e", "applyUrl": "https://thehub.no/jobs/pos_9f8b7c6d5e4a3b2c1d0e/apply", "vouchUrl": "https://thehub.no/jobs/pos_9f8b7c6d5e4a3b2c1d0e/vouch" } ], "careerPagesLinks": [ { "id": "career_001", "idForEmbedded": "career_001.pos_9f8b7c6d5e4a3b2c1d0e", "name": "Nordic Tech Careers", "forAgency": false, "forClient": true, "isDefault": true, "isMarketplace": false, "jobUrl": "https://nordictechsolutions.com/careers/pos_9f8b7c6d5e4a3b2c1d0e", "applyUrl": "https://nordictechsolutions.com/careers/pos_9f8b7c6d5e4a3b2c1d0e/apply", "vouchUrl": "https://nordictechsolutions.com/careers/pos_9f8b7c6d5e4a3b2c1d0e/vouch", "connectUrl": "https://nordictechsolutions.com/careers/connect" } ] } } ``` **SDK Code** ```python import requests url = "https://vouch.careers/api/v1/positions/id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://vouch.careers/api/v1/positions/id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://vouch.careers/api/v1/positions/id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://vouch.careers/api/v1/positions/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://vouch.careers/api/v1/positions/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://vouch.careers/api/v1/positions/id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://vouch.careers/api/v1/positions/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://vouch.careers/api/v1/positions/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```