Skip to content

Fetching a single Rate Card Role

Request

A Rate Card Role can only be accessed by an Administrator on the account.

This endpoint returns structured Rate Card Role objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the rate_card_roles top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • rate_card_version (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.
  • role (Role) - The account Role that this Rate Card Role represents.
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_card_roles/{id}?include=string'

Responses

The Rate Card Role has been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_card_rolesobject
rolesobject
rate_card_versionsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "rate_card_roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "rate": 0,
      "rate_card_version_id": "string",
      "role_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "rate": 0,
      "rate_card_version_id": "string",
      "role_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "rate_card_versions": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}