Get Compensation Benchmarks

get

https://mock-api.carta.com/v1alpha1/corporations/{corporationId}/compensationBenchmarks

Scope(s): read_compensation_benchmarks

Retrieve all compensation benchmarks based on a corporation's compensation plan in Carta Total Compensation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

corporationId

string

required

The identifier of the corporation or issuer. Identifiers can be retrieved via the List Corporations endpoint.

Query Params

postMoneyValuationBucket

string

required

The peer group used to segment the underlying data. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

geoAdjustmentLocation

string

required

The location used to geo-adjust the benchmarks. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

jobArea

string

required

The job area that the underlying data is segmented by. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

compensationType

string

The compensation type of the benchmark. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

An empty compensationType returns benchmark values for all compensation types.

jobSpecialization

string

The job specialization that the underlying data is segmented by. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

An empty jobSpecialization returns the benchmarks for the roll-up segment.

jobLevel

string

The job level that the underlying data is segmented by. Possible values can be retrieved from the GetCompensationBenchmarkAttributes endpoint.

An empty job_level returns the benchmarks for all job levels.

pageSize

int32

The maximum number of benchmarks to return. The service may return fewer than this value.

If unspecified, at most 100 benchmarks will be returned.

The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

A page token received as nextPageToken in a previous Get Compensation Benchmarks response. Provide this to retrieve the subsequent page.

When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Returned if required fields are omitted or if provided fields fail validation.

401Returned if a valid Authorization header has not been included with the request.

403Returned when the user does not have permission to access the resource.

500Returned if an unexpected internal server error is encountered.

defaultAn unexpected error response.