Welcome to our Jobs API documentation.
\nThis API enables you to integrate with our system to access and manage job postings.
\nhttps://jobs.gatewayapis.com/v1
\nThis API requires an API key for authentication. You can obtain your API key from your account manager.
\nInclude your API key in the x-api-key header for all requests.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\nPlease note that this API has rate limits based on your subscription level. If you exceed your rate limit, you will receive a 429 Too Many Requests error.
In the Jobs API, entities are structured in a hierarchical manner. To create and manage job postings, follow this hierarchy:
\nClients: Start by creating a client. A client represents a company or organization for which you will be posting jobs.
\nJobs: Once you have created a client, you can create jobs associated with that client. Jobs represent the positions that are available for candidates to apply for.
\nApplications: After creating a job, you can manage applications for that job. Applications represent individual candidate submissions for a particular job.
\nExample Workflow:
\nCreate a Client: Use the /clients endpoint to create a new client.
Create a Job: After creating a client, use the /clients/{client_id}/job endpoint to create a job under that client.
Manage Applications: Once jobs are created, you can manage candidate applications using the /clients/{client_id}/jobs/{job_id}/applications endpoint.
This hierarchical structure ensures that all resources are correctly linked and organized within the API.
\nIf you have any questions or need assistance, please reach out to our support team at support@gatewayapis.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29320794","collectionId":"ad28a81c-91d4-4442-ac32-2aef0034ecf5","publishedId":"2sA3s3GAvs","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-04T15:38:56.000Z"},"item":[{"name":"Clients","item":[{"name":"List of all clients","id":"27172eab-64bd-4fd8-800b-ae31342f4f57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients?page=1&per_page=10","description":"This endpoint allows you to retrieve a list of clients that are associated with their account. The results are paginated, allowing you to specify the number of clients per page and the page number.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
page (integer, optional): The page number to retrieve. Defaults to 1.
per_page (integer, optional): The number of clients to retrieve per page. Defaults to 10.
The response will be a JSON object containing the client data, along with pagination information.
\nid (integer): The unique identifier of the client.
created_date (string, nullable): The date the client was created.
partner_id (integer): The ID of the partner associated with the client.
name (string): The name of the client.
website (string, nullable): The website URL of the client.
country (integer, nullable): The ID of the country where the client is located. See GET /countries for available countries.
industry (integer, nullable): The ID of the client's industry. See GET /industries for available industries.
is_approved (boolean): Whether the client is approved to be listed on feeds.
logo_mark_path (string, nullable): The path to the client's logo mark image.
logo_main_path (string, nullable): The path to the client's main logo image.
careers_site_url (string, nullable): The URL to the client's careers site.
linkedin_page_id (string, nullable): The LinkedIn page ID of the client.
data_count (integer): The number of clients returned in the current page.
total_clients (integer): The total number of clients associated with the partner.
page (integer): The current page number.
per_page (integer): The number of clients returned per page.
total_pages (integer): The total number of pages available.
success (string): A message indicating the data was fetched successfully.
This endpoint allows you to retrieve detailed information about a specific client.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
The response will be a JSON object containing detailed information about the client.
\nid (integer): The unique identifier of the client.
created_date (string, nullable): The date the client was created.
partner_id (integer): The ID of the partner associated with the client.
name (string): The name of the client.
website (string, nullable): The website URL of the client.
country (integer, nullable): The ID of the country where the client is located. See GET /countries for available countries.
industry (integer, nullable): The ID of the client's industry. See GET /industries for available industries.
is_approved (boolean): Whether the client is approved to be listed on feeds.
logo_mark_path (string, nullable): The path to the client's logo mark image.
logo_main_path (string, nullable): The path to the client's main logo image.
token (string, nullable): The client's token for authentication or other purposes.
careers_site_url (string, nullable): The URL to the client's careers site.
linkedin_page_id (string, nullable): The LinkedIn page ID of the client.
success (string): A message indicating the data was fetched successfully.
This endpoint allows you to create a new client and associate a user with that client. The client is created with various attributes such as name, industry, and country, and the user is created and linked to the client. Clients are required to post and manage jobs.
\nMethod: POST
URL: /partners/{partner_id}-{partner_token}/client
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The request body should be a JSON object with the following fields:
\nclient_name (string, required): The name of the client.
client_website_url (string, required): The website URL of the client.
client_industry_id (integer, required): The ID of the industry associated with the client.
client_country_id (integer, required): The ID of the country associated with the client.
client_logo_mark (string, optional): The path to the client's logo mark image.
client_logo_main (string, optional): The path to the client's main logo image.
user_email (string, required): The email address of the user associated with the client (admin).
user_first_name (string, required): The first name of the user.
user_last_name (string, required): The last name of the user.
The response will be a JSON object that indicates whether the client was successfully created or not.
\nmessage (string): A message indicating the result of the client creation request.This endpoint allows you to update an existing client. Only the fields that need to be updated should be included in the request body.
\nMethod: PUT
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client to be updated.
The request body should be a JSON object containing the fields that need to be updated. The fields are as follows:
\nclient_name (string, optional): The updated name of the client.
client_website_url (string, optional): The updated website URL of the client.
client_industry_id (integer, optional): The updated ID of the client's industry. See GET /industries for available industries.
client_country_id (integer, optional): The updated ID of the client's country. See GET /countries for available countries.
client_logo_mark (string, optional): The updated path to the client's logo mark image.
client_logo_main (string, optional): The updated path to the client's main logo image.
user_email (string, optional): The updated email of the user associated with the client.
user_first_name (string, optional): The updated first name of the user associated with the client.
user_last_name (string, optional): The updated last name of the user associated with the client.
The response will be a JSON object with a success message if the client is updated successfully, or an error message if the update fails.
\nmessage (string): A message indicating the result of the client update process.Email Format: If updating the user_email, it must be in a valid email format.
URL Format: If updating the client_website_url, it must be a valid URL.
Unique Email Domain: If updating the user_email, the email domain must not already be associated with another client.
The /utilities endpoints provide lists of valid options for various fields:
GET /industries: Retrieve a list of available industries.
GET /countries: Retrieve a list of available countries.
The /clients endpoint lets you manage information about clients.
This endpoint retrieves a list of jobs. They do not include jobs that are archived or deleted. Pagination is supported through query parameters.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/jobs
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
page (integer, optional): The page number to retrieve. Defaults to 1.
per_page (integer, optional): The number of jobs per page. Defaults to 10.
The response will be a JSON object containing a paginated list of jobs, with the following fields:
\njob_id (integer): The unique identifier of the job.
client_id (integer): The ID of the client associated with the job.
client_name (string, nullable): The name of the client associated with the job.
created_date (string): The date when the job was created.
job_start_date (string, nullable): The start date of the job.
job_end_date (string, nullable): The end date of the job.
job_title (string): The title of the job.
job_description (string, nullable): The description of the job.
job_description_no_html (string): The job description with HTML tags removed.
job_is_approved (boolean): Indicates whether the job is approved.
job_status (string): The status of the job (Draft, Archived, Deleted, Active).
job_type (string, nullable): The type of job.
job_tags (string, nullable): Tags associated with the job.
job_last_updated_date (string, nullable): The last date when the job was updated.
job_disabled_integrations (array, nullable): A list of disabled integrations for the job.
job_apply_url (string, nullable): The URL to apply for the job.
location_country (string, nullable): The country where the job is located.
location_city (string, nullable): The city where the job is located.
location_post_code (string, nullable): The postal code of the job's location.
location_state (string, nullable): The state where the job is located.
location_street_address (string, nullable): The street address of the job's location.
location_is_remote (boolean): Indicates whether the job is remote.
location_county (string, nullable): The county where the job is located.
salary (string, nullable): The salary for the job.
salary_from (integer, nullable): The lower bound of the salary range.
salary_to (integer, nullable): The upper bound of the salary range.
salary_unit (string, nullable): The unit of salary (e.g., per hour, per year).
salary_currency (string, nullable): The currency of the salary.
data_count (integer): The number of jobs returned in this response.
total_jobs (integer): The total number of jobs available for this partner.
page (integer): The current page of the results.
per_page (integer): The number of results per page.
total_pages (integer): The total number of pages available.
success (string): A message confirming that the jobs data was fetched successfully.
We are looking for a skilled Software Engineer to join our team.
\",\n \"job_description_no_html\": \"We are looking for a skilled Software Engineer to join our team.\",\n \"job_is_approved\": true,\n \"job_status\": \"Active\",\n \"job_type\": \"Permanent\",\n \"job_tags\": [\"python\",\"django\"],\n \"job_last_updated_date\": \"Thu, 15 Jun 2023 00:00:00 GMT\",\n \"job_disabled_integrations\": [\"whatjobs\"],\n \"job_apply_url\": \"https://jobs.examply.com/aTlmAsP0/672997\",\n \"location_country\": \"USA\",\n \"location_city\": \"New York\",\n \"location_post_code\": \"10001\",\n \"location_state\": \"NY\",\n \"location_street_address\": \"123 Main St\",\n \"location_is_remote\": false,\n \"location_county\": \"New York County\",\n \"salary\": \"\",\n \"salary_from\": 80000,\n \"salary_to\": 120000,\n \"salary_unit\": 1,\n \"salary_currency\": 1\n }\n ],\n \"data_count\": 1,\n \"total_jobs\": 15,\n \"page\": 1,\n \"per_page\": 10,\n \"total_pages\": 2,\n \"success\": \"Jobs data fetched successfully.\"\n}"},{"id":"e1d94055-a255-4188-ad71-4243cac6222f","name":"400 Bad request","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/jobs?page=1&per_page=10","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"An error occurred while processing your request.\",\n \"details\": \"Invalid value for 'page'. Expected an integer.\"\n}"},{"id":"c73f2a09-65ef-4e21-a94b-a65360aa6411","name":"403 Forbidden access","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/jobs?page=1&per_page=10","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorised access.\",\n \"success\": false\n}\n"},{"id":"c81d6dc8-6e8e-4363-a3da-f284b74bb823","name":"404 Not found response","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/jobsxyz?page=1&per_page=10","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","jobsxyz"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No data found or an error occurred.\"\n}"},{"id":"397d50e1-b678-4bc2-8061-c5e1f8b26c20","name":"429 Too many requests","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/jobs?page=1&per_page=10","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Rate limit exceeded.\",\n \"details\": \"You have exceeded your API rate limit. Please try again later.\"\n}"},{"id":"7e0c6fd7-f774-4d7f-9968-47e006059219","name":"500 Internal server error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/jobs?page=1&per_page=10","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"A database error occurred.\",\n \"details\": \"Could not connect to the database.\"\n}"}],"_postman_id":"e67aceda-8625-418c-9fc3-89e66ec0fd9c"},{"name":"List of all jobs for given client","id":"2fdd9773-720a-4335-980d-dc09d532482e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","description":"This endpoint retrieves a list of job postings associated with a specific client. Jobs that are archived or deleted are not included in the results. Pagination is supported through query parameters.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
page (integer, optional): The page number to retrieve. Defaults to 1.
per_page (integer, optional): The number of jobs per page. Defaults to 10.
The response will be a JSON object containing a paginated list of jobs, with the following fields:
\njob_id (integer): The unique identifier of the job.
client_id (integer): The ID of the client associated with the job.
client_name (string, nullable): The name of the client associated with the job.
created_date (string): The date when the job was created.
job_start_date (string, nullable): The start date of the job.
job_end_date (string, nullable): The end date of the job.
job_title (string): The title of the job.
job_description (string, nullable): The description of the job.
job_description_no_html (string): The job description with HTML tags removed.
job_is_approved (boolean): Indicates whether the job is approved.
job_status (string): The status of the job (Draft, Archived, Deleted, Active).
job_type (string, nullable): The type of job.
job_tags (string, nullable): Tags associated with the job.
job_last_updated_date (string, nullable): The last date when the job was updated.
job_disabled_integrations (array, nullable): A list of disabled integrations for the job.
job_apply_url (string, nullable): The URL to apply for the job.
location_country (string, nullable): The country where the job is located.
location_city (string, nullable): The city where the job is located.
location_post_code (string, nullable): The postal code of the job's location.
location_state (string, nullable): The state where the job is located.
location_street_address (string, nullable): The street address of the job's location.
location_is_remote (boolean): Indicates whether the job is remote.
location_county (string, nullable): The county where the job is located.
salary (string, nullable): The salary for the job.
salary_from (integer, nullable): The lower bound of the salary range.
salary_to (integer, nullable): The upper bound of the salary range.
salary_unit (string, nullable): The unit of salary (e.g., per hour, per year).
salary_currency (string, nullable): The currency of the salary.
data_count (integer): The number of jobs returned in this response.
total_jobs (integer): The total number of jobs available for this client.
page (integer): The current page of the results.
per_page (integer): The number of results per page.
total_pages (integer): The total number of pages available.
success (string): A message confirming that the jobs data was fetched successfully.
We are looking for a skilled Software Engineer to join our team.
\",\n \"job_description_no_html\": \"We are looking for a skilled Software Engineer to join our team.\",\n \"job_is_approved\": true,\n \"job_status\": \"Active\",\n \"job_type\": \"Permanent\",\n \"job_tags\": [\"python\",\"django\"],\n \"job_last_updated_date\": \"Thu, 15 Jun 2023 00:00:00 GMT\",\n \"job_disabled_integrations\": [\"whatjobs\"],\n \"job_apply_url\": \"https://jobs.examply.com/aTlmAsP0/672997\",\n \"location_country\": \"USA\",\n \"location_city\": \"New York\",\n \"location_post_code\": \"10001\",\n \"location_state\": \"NY\",\n \"location_street_address\": \"123 Main St\",\n \"location_is_remote\": false,\n \"location_county\": \"New York County\",\n \"salary\": \"\",\n \"salary_from\": 80000,\n \"salary_to\": 120000,\n \"salary_unit\": 1,\n \"salary_currency\": 1\n }\n ],\n \"data_count\": 1,\n \"total_jobs\": 15,\n \"page\": 1,\n \"per_page\": 10,\n \"total_pages\": 2,\n \"success\": \"Jobs data fetched successfully.\"\n}\n"},{"id":"012ad30f-ad17-472f-a5e5-9a1af2e16d9f","name":"400 Bad request","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"5"},{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"An error occurred while processing your request.\",\n \"details\": \"Invalid value for 'page'. Expected an integer.\"\n}"},{"id":"7ee1b96b-016d-4add-8774-2f2455f48ee6","name":"403 Forbidden access","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"5"},{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorised access.\",\n \"success\": false\n}\n"},{"id":"f027273c-262a-494e-9cf5-3ec779e5f859","name":"404 Not found response","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"5"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No data found or an error occurred.\"\n}"},{"id":"36796447-416a-4008-bd7d-bd916ec8c774","name":"429 Too many requests","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"5"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Rate limit exceeded.\",\n \"details\": \"You have exceeded your API rate limit. Please try again later.\"\n}"},{"id":"30508d13-4328-4f1c-af30-af7554b39a07","name":"500 Internal server error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs?page=1&per_page=5","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"5"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"A database error occurred.\",\n \"details\": \"Could not connect to the database.\"\n}"}],"_postman_id":"2fdd9773-720a-4335-980d-dc09d532482e"},{"name":"Retrieve job for given client with job ID","id":"570b0fda-7fa1-4a34-8adf-9d96c1c451d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{partner_id}}-{{partner_token}}/clients/{{client_id }}/jobs/{{job_id}}","description":"This endpoint retrieves the details of a specific job posting associated with a specific client. The job details returned are filtered based on the client's ID and job ID. Only active jobs that are not archived or deleted will be returned.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs/{job_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
job_id (integer): The unique identifier of the job.
The response will be a JSON object containing the details of the job, with the following fields:
\njob_id (integer): The unique identifier of the job.
client_id (integer): The ID of the client associated with the job.
client_name (string, nullable): The name of the client associated with the job.
created_date (string): The date when the job was created.
job_start_date (string, nullable): The start date of the job.
job_end_date (string, nullable): The end date of the job.
job_title (string): The title of the job.
job_description (string, nullable): The description of the job.
job_description_no_html (string): The job description with HTML tags removed.
job_is_approved (boolean): Indicates whether the job is approved.
job_status (string): The status of the job (Draft, Archived, Deleted, Active).
job_type (string, nullable): The type of job.
job_tags (string, nullable): Tags associated with the job.
job_last_updated_date (string, nullable): The last date when the job was updated.
job_disabled_integrations (array, nullable): A list of disabled integrations for the job.
job_apply_url (string, nullable): The URL to apply for the job.
location_country (string, nullable): The country where the job is located.
location_city (string, nullable): The city where the job is located.
location_post_code (string, nullable): The postal code of the job's location.
location_state (string, nullable): The state where the job is located.
location_street_address (string, nullable): The street address of the job's location.
location_is_remote (boolean): Indicates whether the job is remote.
location_county (string, nullable): The county where the job is located.
salary (string, nullable): The salary for the job.
salary_from (integer, nullable): The lower bound of the salary range.
salary_to (integer, nullable): The upper bound of the salary range.
salary_unit (string, nullable): The unit of salary (e.g., per hour, per year).
salary_currency (string, nullable): The currency of the salary.
success (string): A message confirming that the job data was fetched successfully.
We are looking for a skilled Software Engineer to join our team.
\",\n \"job_description_no_html\": \"We are looking for a skilled Software Engineer to join our team.\",\n \"job_is_approved\": true,\n \"job_status\": \"Active\",\n \"job_type\": \"Permanent\",\n \"job_tags\": [\"python\",\"django\"],\n \"job_last_updated_date\": \"Thu, 15 Jun 2023 00:00:00 GMT\",\n \"job_disabled_integrations\": [\"whatjobs\"],\n \"job_apply_url\": \"https://jobs.examply.com/aTlmAsP0/672997\",\n \"location_country\": \"USA\",\n \"location_city\": \"New York\",\n \"location_post_code\": \"10001\",\n \"location_state\": \"NY\",\n \"location_street_address\": \"123 Main St\",\n \"location_is_remote\": false,\n \"location_county\": \"New York County\",\n \"salary\": \"\",\n \"salary_from\": 80000,\n \"salary_to\": 120000,\n \"salary_unit\": 1,\n \"salary_currency\": 1\n },\n \"success\": \"Job data fetched successfully.\"\n}\n"},{"id":"b647b5eb-57a8-4fc8-8747-b2a2d3c0c74a","name":"403 Forbidden access","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":{"raw":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}","protocol":"https","host":["jobs","gatewayapis","com"],"path":["v1","partners","{{partner_id}}-{{partner_token}}","clients","{{client_id}}","jobs","{{job_id}}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorised access.\",\n \"success\": false\n}\n"},{"id":"e36ded6e-496a-49cb-b735-b91b85205415","name":"404 Not found response","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No data found or an error occurred.\"\n}"},{"id":"3a5dfb2d-0b7d-4f98-9ecb-36fe21125c1b","name":"429 Too many requests","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Rate limit exceeded.\",\n \"details\": \"You have exceeded your API rate limit. Please try again later.\"\n}"},{"id":"ee86d670-6b71-4168-8251-458c04312e4e","name":"500 Internal server error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"A database error occurred.\",\n \"details\": \"Could not connect to the database.\"\n}"}],"_postman_id":"570b0fda-7fa1-4a34-8adf-9d96c1c451d3"},{"name":"Create job for given client","id":"283b2155-d97d-48a1-9bea-57c35e89b229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.We are looking for a skilled Software Engineer to join our team.We are looking for a skilled Software Engineer to join our team.We are looking for a skilled Software Engineer to join our team.We are looking for a skilled Software Engineer to join our team.We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"jess+12912912912912912@examply.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{partner_id}}-{{partner_token}}/clients/{{client_id }}/job","description":"This endpoint allows you to create a new job for a specific client. The job details, including its title, description, location, salary, and other related attributes, are provided in the request body.
\nMethod: POST
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/job
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
The request body should be a JSON object containing the following fields:
\ndisabled_integrations (list, optional): A list of integrations to be disabled for this job. See GET /integrations for a list of available integrations.
job_title (string, required): The title of the job.
\njob_description (string, required): The description of the job. Must contain valid HTML, but class attributes in HTML elements are not allowed.
\njob_type_id (integer, required): The ID of the job type. See GET /job-types for a list of available job types.
job_start_date (string, required): The start date of the job in YYYY-MM-DD format.
job_tags (string, optional): Tags associated with the job.
\nlocation_street_address (string, conditional, required if the job is not remote): The street address of the job location.
\nlocation_city (string, required): The city of the job location.
\nlocation_county (string, required): The county of the job location.
\nlocation_post_code (string, conditional, required if the job is not remote): The postal code of the job location.
\nlocation_country_id (integer, required): The ID of the country where the job is located. See GET /countries for a list of available countries.
location_is_remote (boolean, required): Indicates if the job is remote.
\nsalary_text (string, optional): A text description of the salary.
\nsalary_range_from (decimal, conditional, required if salary_text is not provided): The starting range of the salary.
salary_range_to (decimal, conditional, required if salary_text is not provided): The ending range of the salary.
salary_range_unit (string, conditional, required if salary_text is not provided): The unit of the salary range (e.g., yearly, monthly). See GET /salary-units for a list of available salary units.
salary_range_currency (string, conditional, required if salary_text is not provided): The currency of the salary range. See GET /currencies for a list of available currencies.
user_email (string, required): The email of the user who is adding the job.
\nThe response will be a JSON object with a success message if the job is created successfully, or an error message if the job creation fails.
\nmessage (string): A message indicating the result of the job creation process.Salary Fields: Either salary_text or salary_range_from, salary_range_to, salary_range_unit, and salary_range_currency should be provided, but not both.
Location Fields: For remote jobs, only location_city, location_county, and location_country_id should be provided. For non-remote jobs, all location fields (location_street_address, location_city, location_county, location_post_code) are required.
Job Description: The job description must be at least 200 characters long and not include profanities.
\nThe /utilities endpoints provide lists of valid options for various fields:
GET /integrations: Retrieve a list of available integrations to use in the disabled_integrations field.
GET /job-types: Retrieve a list of available job types to use in the job_type_id field.
GET /countries: Retrieve a list of available countries to use in the location_country_id field.
GET /salary-units: Retrieve a list of available salary units to use in the salary_range_unit field.
GET /currencies: Retrieve a list of available currencies to use in the salary_range_currency field.
We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Job created successfully with ID: 1234567.\"\n}"},{"id":"c3cdb004-4388-4be6-bdce-f0d86d6752cd","name":"400 Bad request - Missing required fields","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Missing required fields.\"\n}"},{"id":"1af40002-3b8e-48c3-8706-a7d85f0e8a7c","name":"400 Bad request - Salary invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Salary 'to' must be greater than salary 'from'.\"\n}"},{"id":"7e09a9b1-ae00-43a2-9d80-bf5845f919ef","name":"400 Bad request - Location invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Provide only city, county, and country ID for remote jobs.\"\n}"},{"id":"fd92d012-9a3a-41de-9d53-a02d87024906","name":"400 Bad request - Salary invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Provide only city, county, and country ID for remote jobs.\"\n}"},{"id":"9da593b1-02eb-44ab-864f-09c70f737c80","name":"403 Forbidden access","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorised access.\",\n \"success\": false\n}"},{"id":"60079843-54a6-4a63-a91b-589a4280a055","name":"500 Internal server error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/job"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"An unexpected error occurred.\",\n \"details\": \"Failed to connect to the database.\"\n}"}],"_postman_id":"283b2155-d97d-48a1-9bea-57c35e89b229"},{"name":"Update job with a given job ID","id":"0953ef43-d097-4ead-b466-02a70d839cfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"indeed\", \"linkedin\"],\n \"job_title\": \"Senior Python Developer\",\n \"job_description\": \"Join our team as a Senior Python Developer to lead our backend development efforts.
\",\n \"job_type_id\": 2,\n \"job_tags\": \"python, senior, backend, development\",\n \"location_street_address\": \"4321 Tech Avenue\",\n \"location_city\": \"New York\",\n \"location_county\": \"New York County\",\n \"location_post_code\": \"10001\",\n \"location_country_id\": 223,\n \"location_is_remote\": false,\n \"salary_text\": null,\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 1,\n \"end_date\": \"2025-06-30\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}","description":"This endpoint allows you to update an existing job for a specific client. Only the fields that need to be updated should be included in the request body.
\nMethod: PUT
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs/{job_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
job_id (integer): The unique identifier of the job to be updated.
The request body should be a JSON object containing the fields that need to be updated. The fields are as follows:
\ndisabled_integrations (list, optional): A list of integrations to be disabled for this job. See GET /integrations for available integrations.
job_title (string, optional): The updated title of the job.
job_description (string, required): The updated job description. Must contain valid HTML, but class attributes in HTML elements are not allowed.
\njob_type_id (integer, optional): The ID of the updated job type. See GET /job-types for available job types.
job_tags (string, optional): Updated tags associated with the job.
location_street_address (string, optional): The updated street address of the job location (only required if the job is not remote).
location_city (string, optional): The updated city of the job location.
location_county (string, optional): The updated county of the job location.
location_post_code (string, optional): The updated postal code of the job location (only required if the job is not remote).
location_country_id (integer, optional): The updated ID of the country where the job is located. See GET /countries for available countries.
location_is_remote (boolean, optional): Indicates whether the job is remote.
salary_text (string, optional): An updated text description of the salary.
salary_range_from (decimal, optional): The updated starting range of the salary.
salary_range_to (decimal, optional): The updated ending range of the salary.
salary_range_unit (string, optional): The updated unit of the salary range (e.g., yearly, monthly). See GET /salary-units for available salary units.
salary_range_currency (string, optional): The updated currency of the salary range. See GET /currencies for available currencies.
end_date (string, optional): The updated job end date. Must be in YYYY-MM-DD format and a todays date if the job is currently open. If the job is currently ended (an existing end_date in the past) the end_date must be a future date, not today.
The response will be a JSON object with a success message if the job is updated successfully, or an error message if the update fails.
\nmessage (string): A message indicating the result of the job update process.Salary Fields: Either salary_text or salary_range_from, salary_range_to, salary_range_unit, and salary_range_currency should be provided, but not both.
Location Fields: For remote jobs, only location_city, location_county, and location_country_id should be provided. For non-remote jobs, all location fields (location_street_address, location_city, location_county, location_post_code) are required.
Job Description: The job description must be at least 200 characters long and should not include profanities.
\nEnd Date (end_date):
Must be in YYYY-MM-DD format.
Must be a future date (greater than today’s date).
\nMust be after firstPosted.
The /utilities endpoints provide lists of valid options for various fields:
GET /integrations: Retrieve a list of available integrations to use in the disabled_integrations field.
GET /job-types: Retrieve a list of available job types to use in the job_type_id field.
GET /countries: Retrieve a list of available countries to use in the location_country_id field.
GET /salary-units: Retrieve a list of available salary units to use in the salary_range_unit field.
GET /currencies: Retrieve a list of available currencies to use in the salary_range_currency field.
Join our team as a Senior Python Developer to lead our backend development efforts.
\",\n \"job_type_id\": 2,\n \"job_tags\": \"python, senior, backend, development\",\n \"location_street_address\": \"4321 Tech Avenue\",\n \"location_city\": \"New York\",\n \"location_county\": \"New York County\",\n \"location_post_code\": \"10001\",\n \"location_country_id\": 223,\n \"location_is_remote\": false,\n \"salary_text\": null,\n \"salary_range_from\": \"90000\",\n \"salary_range_to\": \"120000\",\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 1,\n \"user_email\": \"johndoe@example.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Job updated successfully.\"\n}"},{"id":"845994f3-f5f1-4c80-9e8f-95128d6c874d","name":"400 Bad request - Missing required fields","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Missing required fields.\"\n}"},{"id":"8a71521a-9285-4b41-b7b7-14f64df35da8","name":"400 Bad request - Salary invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Salary 'to' must be greater than salary 'from'.\"\n}"},{"id":"6e36d9e9-4460-4522-ba50-b973aa5c3859","name":"400 Bad request - Location invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Provide only city, county, and country ID for remote jobs.\"\n}"},{"id":"95b7dd29-9550-4b94-b27a-8cdc3ff0efd0","name":"400 Bad request - Salary invalid","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Provide only city, county, and country ID for remote jobs.\"\n}"},{"id":"f16881a4-d8be-4d8d-aeee-5945c9255db4","name":"403 Forbidden access","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorised access.\",\n \"success\": false\n}"},{"id":"5b4b20bd-d5e5-448a-8ad4-ab21e5cf04eb","name":"500 Internal server error Copy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"disabled_integrations\": [\"ziprecruiter\", \"jooble\"],\n \"job_title\": \"Python Engineer\",\n \"job_description\": \"We are looking for a skilled Software Engineer to join our team.
\",\n \"job_type_id\": 1,\n \"job_start_date\": \"2024-08-01\",\n \"job_tags\": \"software, engineering, development\",\n \"location_street_address\": \"1234 Market Street\",\n \"location_city\": \"San Francisco\",\n \"location_post_code\": \"94105\",\n \"location_county\": \"San Francisco County\",\n \"location_country_id\": 77,\n \"location_is_remote\": false,\n // \"salary_text\": \"60,000 - 80,000 USD per annum\",\n \"salary_range_from\": 50000,\n \"salary_range_to\": 80000,\n \"salary_range_unit\": 1,\n \"salary_range_currency\": 3,\n \"user_email\": \"ted@abc42345678.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"An unexpected error occurred.\",\n \"details\": \"Failed to connect to the database.\"\n}"}],"_postman_id":"0953ef43-d097-4ead-b466-02a70d839cfc"},{"name":"Delete job with given job ID","id":"91332286-7e96-4274-bb22-138d82146830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://jobs.gatewayapis.com/v1/partners/{{partner_id}}-{{partner_token}}/clients/{{client_id}}/jobs/{{job_id}}","description":"This endpoint allows you to delete a specific job posting associated with a specific client.
\nMethod: DELETE
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs/{job_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
job_id (integer): The unique identifier of the job to be deleted.
The response will be a JSON object indicating the success or failure of the deletion operation, with the following fields:
\nmessage (string): A message indicating the result of the operation.
success (boolean): A flag indicating whether the job was successfully deleted.
The /jobs endpoint lets you manage information about jobs related to all clients.
This endpoint retrieves a list of job applications associated with a specific job posting for a specific client. The applications returned are filtered based on the job ID and client ID. Pagination is supported through query parameters.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs/{job_id}/applications
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
job_id (integer): The unique identifier of the job.
page (integer, optional): The page number to retrieve. Defaults to 1.
per_page (integer, optional): The number of applications per page. Defaults to 10.
The response will be a JSON object containing a paginated list of applications, with the following fields:
\napplication_id (integer): The unique identifier of the application.
user_email (string): The email address of the user who applied.
user_first_name (string): The first name of the user who applied.
user_last_name (string): The last name of the user who applied.
job_id (integer): The unique identifier of the job.
cover_note (string, nullable): The cover note provided by the applicant.
phone (string, nullable): The phone number of the applicant.
headline (string, nullable): The headline provided by the applicant.
source (string, nullable): The source from which the application originated.
cv_path (string, nullable): The path to the CV uploaded by the applicant.
data_count (integer): The number of applications returned in this response.
total_applications (integer): The total number of applications available for this job.
page (integer): The current page of the results.
per_page (integer): The number of results per page.
total_pages (integer): The total number of pages available.
success (string): A message confirming that the applications data was fetched successfully.
This endpoint retrieves detailed information about a specific job application associated with a specific job posting for a specific client.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/clients/{client_id}/jobs/{job_id}/applications/{application_id}
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
client_id (integer): The unique identifier of the client.
job_id (integer): The unique identifier of the job.
application_id (integer): The unique identifier of the application.
The response will be a JSON object containing detailed information about the specified application, with the following fields:
\napplication_id (integer): The unique identifier of the application.
user_email (string): The email address of the user who applied.
user_first_name (string): The first name of the user who applied.
user_last_name (string): The last name of the user who applied.
job_id (integer): The unique identifier of the job.
cover_note (string, nullable): The cover note provided by the applicant.
phone (string, nullable): The phone number of the applicant.
headline (string, nullable): The headline provided by the applicant.
source (string, nullable): The source from which the application originated.
cv_path (string, nullable): The path to the CV uploaded by the applicant.
data_count (integer): The number of records in the response (typically 1).
success (string): A message confirming that the application data was fetched successfully.
The /applications endpoint lets you manage information about applications for given jobs.
This endpoint allows you to retrieve a list of all available countries, which can be used for setting job locations, client addresses, and more.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/utilities/countries
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The response will be a JSON object containing the list of countries.
\ncountry_id (integer): The unique identifier of the country.
\ncountry_name (string): The name of the country.
\niso_code (string): The ISO 3166-1 alpha-2 country code.
\ndata_count (integer): The number of countries retrieved.
\nsuccess (string): A message indicating the successful retrieval of the countries data.
\nThis endpoint allows you to retrieve a list of all available currencies, which can be used for specifying salary information in job postings and other related functionalities.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/utilities/currencies
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The response will be a JSON object containing the list of currencies.
\ncurrency_id (integer): The unique identifier of the currency.
\ncurrency_short (string): The short code (e.g., USD, EUR) representing the currency.
\ndata_count (integer): The number of currencies retrieved.
\nsuccess (string): A message indicating the successful retrieval of the currencies data.
\nThis endpoint allows you to retrieve a list of available integrations that can be used within the system.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/utilities/integrations
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The response will be a JSON object containing the list of available integrations.
\nid (string): The unique identifier of the integration.
\nsuccess (string): A message indicating the successful retrieval of the integrations data.
\nThis endpoint allows you to retrieve a list of all available industries. Each industry is identified by an ID and a name.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/utilities/industries
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The response will be a JSON object containing the list of industries.
\nid (integer): The unique identifier of the industry.
\nname (string): The name of the industry.
\nsuccess (string): A message indicating the successful retrieval of the industries data.
\nThis endpoint allows you to retrieve a list of all available job types. Each job type is identified by an ID and a name.
\nMethod: GET
URL: /partners/{partner_id}-{partner_token}/utilities/job-types
partner_id (integer): Your unique partner ID.
partner_token (string): Your unique partner token.
The response will be a JSON object containing the list of job types.
\nid (integer): The unique identifier of the job type.
\nname (string): The name of the job type.
\nsuccess (string): A message indicating the successful retrieval of the job types data.
\nThe /utilities endpoint provides access to essential reference information such as available currencies, countries, industries, job types, and integrations.
This webhook is triggered whenever a new application is created. It sends the application details to your webhook URL for further processing.
\nEvent Name: application_created
Description: Triggered when a new job application is submitted.
\nHTTP Method: POST
Content-Type: application/json
URL: Your webhook URL
\nTo ensure that webhook requests are authentic and have not been tampered with, each request includes an X-Hook-Signature header. This header contains a cryptographic signature that allows you to verify the integrity and authenticity of the payload.
The X-Hook-Signature is an HMAC (Hash-based Message Authentication Code) generated using the following:
Payload: The data being sent in the webhook.
\nShared secret: A unique secret key (partnerWebhookKey) provided to you by your account manager.
The signature is created using the HMAC-SHA256 algorithm.
\nTo validate the webhook:
\nRetrieve the X-Hook-Signature header from the incoming request.
Compute a signature on your end using:
\nThe exact payload received.
\nYour shared secret (partnerWebhookKey).
Compare the computed signature with the X-Hook-Signature header. If they match, the request is authentic.
The webhook sends the following payload:
\n{\n \"event\": \"application_created\",\n \"data\": {\n \"application_id\": 12345,\n \"user_id\": 67890,\n \"job_id\": 23456,\n \"cover_note\": \"I am very interested in this role because...\",\n \"source\": \"LinkedIn\",\n \"phone\": \"+1234567890\",\n \"headline\": \"Experienced Software Engineer\",\n \"cv_path\": \"/uploads/cvs/12345.pdf\"\n }\n}\n\n