Skip to content

Fetching a list of Rate Card Sets

Request

Rate Card Sets are only accessible to users with Financial access (Project Lead or higher) on the account.

An initial request to this endpoint, will generate an account default Rate Card Set and a create a Rate Card Set Version. This account default Rate Card Set will include a separate Rate Card for every currency used in projects on the user's account.

This endpoint returns structured Rate Card Set 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_sets top-level JSON key. Please see our Response Format section for more information.

Query
activeboolean

Includes only Rate Card Sets with published Rate Card Set Versions.

created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

has_active_currencystring

Includes only Rate Card Sets that have a rate card with the specified currency and belong to a published Rate Card Set Version.

has_currencystring

Includes only Rate Card Sets that have a rate card with the specified currency.

includestring

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

  • rate_card_set_versions (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.
  • rate_cards (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.
  • workspace_groups (WorkspaceGroup) - Groups associated with the Rate Card Set.
matchingstring

Includes only Rate Card Sets with a title matching the specified term.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, title:asc, and title:desc.

Default:"created_at:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

workspace_groupsstring

Filter rate card sets by their associated workspace groups. Provide a comma-separated list of workspace group IDs, for example 10,20.

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_card_sets?active=true&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&has_active_currency=string&has_currency=string&include=string&matching=string&only=string&order=created_at%3Aasc&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&workspace_groups=string'

Responses

A list of Rate Card Sets have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_card_setsobject
rate_cardsobject
rate_card_set_versionsobject
workspace_groupsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "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_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
    }
  },
  "rate_card_set_versions": {
    "property1": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    },
    "property2": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    }
  },
  "workspace_groups": {
    "property1": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    },
    "property2": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    }
  }
}