Skip to content

Fetching a single Rate Card

Request

This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account.

This endpoint returns structured Rate Card 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_cards 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.

  • effective_rate_card_version (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the only parameter.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_set (RateCardSet) - The Rate Card Set to which this Rate Card belongs.
  • rate_card_versions (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns.
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_cards/{id}?include=string'

Responses

The Rate Card has been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_cardsobject
external_referencesobject
rate_card_setsobject
rate_card_versionsobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "rate_cards": { "property1": { "created_at": "2019-08-24T14:15:22Z", "currency": "string", "effective_rate_card_version_id": "string", "external_reference_ids": [ "string" ], "rate_card_set_id": "string", "rate_card_set_title": "string", "rate_card_version_ids": [ "string" ], "removable": true, "updated_at": "2019-08-24T14:15:22Z", "uses": 0 }, "property2": { "created_at": "2019-08-24T14:15:22Z", "currency": "string", "effective_rate_card_version_id": "string", "external_reference_ids": [ "string" ], "rate_card_set_id": "string", "rate_card_set_title": "string", "rate_card_version_ids": [ "string" ], "removable": true, "updated_at": "2019-08-24T14:15:22Z", "uses": 0 } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "rate_card_sets": { "property1": { "account_default": true, "active_currencies": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_currencies": [ "string" ], "destroyable": true, "rate_card_ids": [ "string" ], "rate_card_set_version_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ] }, "property2": { "account_default": true, "active_currencies": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_currencies": [ "string" ], "destroyable": true, "rate_card_ids": [ "string" ], "rate_card_set_version_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ] } }, "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" } } }