{
  "opencollection": "1.0.0",
  "info": {
    "name": "Compensation Benchmarks Dimensions API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Dimensions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get jobs V1",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/jobs",
            "params": [
              {
                "name": "hierarchy",
                "value": "",
                "type": "query",
                "description": "The ID of the job hierarchy to navigate.\n\nIf not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings.\n"
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "The ID of the parent member.\n\nIf the ID is provided, the response returns the immediate children of the parent member.\n\nTo get the top-level members, use the value `root`.\n\nMember availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter.\n"
              },
              {
                "name": "term",
                "value": "",
                "type": "query",
                "description": "The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. \nYour search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results.\n\nThe minimum length is 2 characters and the maximum length is 100 characters.\n\n***The search term must be URL encoded.***\n"
              },
              {
                "name": "naicsCode",
                "value": "",
                "type": "query",
                "description": "The North American Industry Classification System (NAICS) code.\n\nIf `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "semanticOnly",
                "value": "",
                "type": "query",
                "description": "If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`.\nDefault is `false`. By default, both semantic and lexical search are used to find matches.\n"
              },
              {
                "name": "lexicalOnly",
                "value": "",
                "type": "query",
                "description": "If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. \nDefault is `false`. By default, both semantic and lexical search are used to find matches.\n"
              },
              {
                "name": "typicalTitlesSearch",
                "value": "",
                "type": "query",
                "description": "If `true`, similar job titles for a job member are included in the lexical search for matches.\nDefault is `false`.\n"
              },
              {
                "name": "showHierarchy",
                "value": "",
                "type": "query",
                "description": "If `true`, returns members in a tree structure based on the occupation hierarchy.\nDefault is `false`.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all the jobs in Visier's ontology. A new version of this endpoint is now available. For more information, see `GET /v2/compensation-benchmarks/jobs`.\n"
        },
        {
          "info": {
            "name": "Get jobs V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/compensation-benchmarks/jobs",
            "params": [
              {
                "name": "hierarchy",
                "value": "",
                "type": "query",
                "description": "The ID of the job hierarchy to navigate.\n\nIf not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings.\n"
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "The ID of the parent member.\n\nIf the ID is provided, the response returns the immediate children of the parent member.\n\nTo get the top-level members, use the value `root`.\n\nMember availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter.\n"
              },
              {
                "name": "term",
                "value": "",
                "type": "query",
                "description": "The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. \nYour search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results.\n\nThe minimum length is 2 characters and the maximum length is 100 characters.\n\n***The search term must be URL encoded.***\n"
              },
              {
                "name": "naicsCode",
                "value": "",
                "type": "query",
                "description": "The North American Industry Classification System (NAICS) code.\n\nIf `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "semanticOnly",
                "value": "",
                "type": "query",
                "description": "If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`.\nDefault is `false`. By default, both semantic and lexical search are used to find matches.\n"
              },
              {
                "name": "lexicalOnly",
                "value": "",
                "type": "query",
                "description": "If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. \nDefault is `false`. By default, both semantic and lexical search are used to find matches.\n"
              },
              {
                "name": "typicalTitlesSearch",
                "value": "",
                "type": "query",
                "description": "If `true`, similar job titles for a job member are included in the lexical search for matches.\nDefault is `false`.\n"
              },
              {
                "name": "showHierarchy",
                "value": "",
                "type": "query",
                "description": "If `true`, returns members in a tree structure based on the occupation hierarchy.\nDefault is `false`.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The subset of the overall result set to return. The number of rows per page is equal to `limit`, except the last page which may contain fewer rows. Page is an index that begins at 0. The index to start retrieving results is calculated by multiplying `page` by `limit`. Default is to return results for page 0.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return. Default and maximum are 1000 entries.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all the jobs in Visier's ontology. Jobs V2 improves upon Jobs V1 in the following ways:\n- Supports pagination through the `page` and `limit` parameters.\n- Returns both the short and long versions of job descriptions and job typical titles.\n"
        },
        {
          "info": {
            "name": "Standardize custom job titles in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/jobs/standardize",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Find the top standardized job matches for any custom job title and optional NAICS code in bulk.\n"
        },
        {
          "info": {
            "name": "Get job hierarchies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/jobs/hierarchies",
            "params": [
              {
                "name": "naicsCode",
                "value": "",
                "type": "query",
                "description": "The North American Industry Classification System (NAICS) code.\n\nIf provided, the response returns the hierarchies associated with the code.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all hierarchies used to organize jobs.\n"
        },
        {
          "info": {
            "name": "Search jobs by IDs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/jobs/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a matching job for each specified job ID.\n"
        },
        {
          "info": {
            "name": "Send feedback to help improve the quality of the job match results",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/jobs/feedback",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "This API allows you to submit feedback on the quality of the job match results returned by the Get jobs endpoint. \n\nYou must include the search term (job title you entered) in the request body. You can include the optional `naicsCode` if it was used as part of the search in the Get jobs endpoint.\n\nYou can also submit additional comments by providing values for `additionalComments`, along with `term` and `naicsCode`.\n\n**Note:**\n\nFor `term`, the minimum is 2 characters and the maximum is 100 chara"
        },
        {
          "info": {
            "name": "Get industries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/industries",
            "params": [
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "The ID of the parent member.\n\nIf the ID is provided, the response returns the immediate children of the parent member.\n\nTo get the top-level members, use the value `root`.\n"
              },
              {
                "name": "naicsCode",
                "value": "",
                "type": "query",
                "description": "The North American Industry Classification System (NAICS) code.\n\nIf provided, the response returns the best matching member associated with the code.\n"
              },
              {
                "name": "showHierarchy",
                "value": "",
                "type": "query",
                "description": "If `true`, returns members in a tree structure based on the industry hierarchy.\nDefault is `false`.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all available industries.\n"
        },
        {
          "info": {
            "name": "Get locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/locations",
            "params": [
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "The ID of the parent member.\n\nIf the ID is provided, the response returns the immediate children of the parent member.\n\nTo get the top-level member, use the value `root`.\n"
              },
              {
                "name": "countryCode",
                "value": "",
                "type": "query",
                "description": "The **ISO 3166-1** country code to look up. Returns location members that match the country code.\n\nCurrently, the only supported country code is `US`.\n"
              },
              {
                "name": "postalCode",
                "value": "",
                "type": "query",
                "description": "Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code.\n"
              },
              {
                "name": "showHierarchy",
                "value": "",
                "type": "query",
                "description": "If `true`, returns members in a tree structure based on the location hierarchy.\nDefault is `false`.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all available locations.\n"
        },
        {
          "info": {
            "name": "Get location members in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/locations/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve location members in bulk by country code and postal code.\n"
        },
        {
          "info": {
            "name": "Get company sizes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/company-sizes",
            "params": [
              {
                "name": "headcount",
                "value": "",
                "type": "query",
                "description": "The number of employees.\n\nIf provided, the response returns the members with the same headcount.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all available company sizes.\n"
        },
        {
          "info": {
            "name": "Get career levels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/career-levels",
            "params": [
              {
                "name": "job",
                "value": "",
                "type": "query",
                "description": "The job member ID.\n\nIf provided, the response returns the members for the job.\n"
              },
              {
                "name": "hasBenchmarkValue",
                "value": "",
                "type": "query",
                "description": "Filter members based on the availability of benchmark values. \nIf `true`, members with benchmark values are returned. \nIf `false`, members without benchmark values are returned. \nIf no value is specified, all members are returned.\n"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of all available career levels.\n"
        },
        {
          "info": {
            "name": "Get career level members in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/career-levels/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve career level members in bulk by job IDs.\n"
        },
        {
          "info": {
            "name": "Retrieve taxonomy changes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/compensation-benchmarks/taxonomy-change-info",
            "auth": {
              "type": "apikey",
              "key": "apikey",
              "value": "{{apikey}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a list of taxonomy changes in CSV format, including updates to jobs, locations, industries, career levels, and company size up to the latest release.\n"
        }
      ]
    }
  ],
  "bundled": true
}