client.usage_limits.list_matching

A method of the Usage Limits endpoint.

list_matching(*, task: str = None) → ListResponse

List Matching Usage Limits

API URL: GET /usage_limits/matching

import civis
client = civis.APIClient()
response = client.usage_limits.list_matching(...)

Parameters:

taskstr, optional

If specified, return limits for this task type only. One of ‘IDR’ or ‘CDM’.

Returns:

civis.ListResponse

• idint

  The ID for the limit.

• organization_idint

  The ID of the organization to which this limit belongs.

• created_atstr (time)

  The time this limit was created.

• updated_atstr (time)

  The time the limit was last updated.

• hard_limitint

  The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.

• taskstr

  The category of this limit. One of ‘IDR’ or ‘CDM’.

• notification_emailsList[str]

  Addresses to notify by e-mail when the limit is reached.