# Policies

A Policy object sets the rules for how specific users can or cannot use a particular curb at designated times. Each Curb Zone's regulations are defined by a combination of multiple Policy objects. Querying Curb Policies can provide the full set of policies.

## GET /curbs/policies

> Query Curb Policies

```json
{"openapi":"3.1.0","info":{"title":"CurbIQ API","version":"1.0.0"},"servers":[{"url":"https://v2.curbiq-curb-api.io","description":"CurbIQ's Curb API (v1)"}],"paths":{"/curbs/policies":{"get":{"operationId":"getCurbPolicies","summary":"Query Curb Policies","parameters":[{"name":"curbiq_token","in":"query","required":true,"schema":{"type":"string"},"description":"The CurbIQ token provided to you when you registered for the API."},{"name":"ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"style":"form","explode":false},"description":"CDS  \nA list of curb policy ids to query, separated by commas.  \nIf present, return only policies with the supplied UUIDs. Otherwise, return all policies.\n"},{"name":"zone","in":"query","required":false,"schema":{"type":"string","format":"uuid"},"description":"CCDS  \nThe ID of a Curb Zone.  \nIf specified, only return Curb Policies associated with this zone.\n"},{"name":"time","in":"query","required":false,"schema":{"type":"integer","format":"int64"},"description":"CCDS  \nFilter Curb Zones based on validity at this timestamp (in ms).\n"},{"name":"curb_policy_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"},"description":"CCDS  \nFilter by a specific curb policy ID.\n"},{"name":"response_size","in":"query","required":false,"schema":{"type":"integer"},"description":"CCDS  \nMax is 250. Default is 100.\n"},{"name":"page_num","in":"query","required":false,"schema":{"type":"integer"},"description":"CCDS  \nPage number for paginated results. Default is 1.\n"}],"responses":{"200":{"description":"A successful response containing Curb Policies.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"time_zone":{"type":"string"},"last_updated":{"type":"number"},"currency":{"type":"string"},"author":{"type":"string"},"licence_url":{"type":"string","nullable":true},"ccds_attributes":{"type":"object","properties":{"type":{"type":"string"},"request_type":{"type":"string"},"city_id":{"type":"string"},"city_name":{"type":"string"},"query_parameters":{"type":"object","properties":{"curb_policy_id":{"type":"string"},"curbiq_token":{"type":"string"}}}}},"pages":{"type":"object","properties":{"total":{"type":"integer"},"current":{"type":"integer"}}},"data":{"type":"array","items":{"type":"object","properties":{"policies":{"type":"array","items":{"type":"object","properties":{"curb_policy_id":{"type":"string"},"published_date":{"type":"integer"},"priority":{"type":"integer"},"data_source_operator_id":{"type":"string","nullable":true},"timespans":{"type":"array","items":{"type":"object","properties":{"days_of_week":{"type":"array","items":{"type":"string"}},"months":{"type":"array","items":{"type":"string","nullable":true}},"days_of_month":{"type":"array","items":{"type":"string","nullable":true}},"time_of_day_start":{"type":"string"},"time_of_day_end":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":"string","nullable":true},"designated_period":{"type":"string","nullable":true}}}},"rules":{"type":"array","items":{"type":"object","properties":{"activity":{"type":"string"},"max_stay":{"type":"number","nullable":true},"max_stay_unit":{"type":"string"},"no_return":{"type":"number","nullable":true},"no_return_unit":{"type":"string"},"user_classes":{"type":"array","items":{"type":"string","nullable":true}},"rate":{"type":"object","properties":{"rate":{"type":"number"},"rate_unit":{"type":"string"},"rate_unit_period":{"type":"string"}}}}}}}}}}}}}}}}}},"tags":["curbs"]}}}}
```

## GET /curbs/policies/{curb\_policy\_id}

> Fetch Curb Policy

```json
{"openapi":"3.1.0","info":{"title":"CurbIQ API","version":"1.0.0"},"servers":[{"url":"https://v2.curbiq-curb-api.io","description":"CurbIQ's Curb API (v1)"}],"paths":{"/curbs/policies/{curb_policy_id}":{"get":{"operationId":"getCurbPoliciesbyUUID","summary":"Fetch Curb Policy","parameters":[{"name":"curb_policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The unique identifier for the Curb Policy."},{"name":"curbiq_token","in":"query","required":true,"schema":{"type":"string"},"description":"The CurbIQ token provided to you when you registered for the API."},{"name":"response_size","in":"query","required":false,"schema":{"type":"integer"},"description":"CCDS  \nDefault is 100. The maximum response size is 250.\n"},{"name":"page_num","in":"query","required":false,"schema":{"type":"integer"},"description":"CCDS  \nPage number for paginated responses, default is 1.\n"}],"responses":{"200":{"description":"A successful response containing Curb Policies.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"time_zone":{"type":"string"},"last_updated":{"type":"number"},"currency":{"type":"string"},"author":{"type":"string"},"licence_url":{"type":["string","null"]},"ccds_attributes":{"type":"object","properties":{"type":{"type":"string"},"request_type":{"type":"string"},"city_id":{"type":"string","format":"uuid"},"city_name":{"type":"string"},"query_parameters":{"type":"object","properties":{"curb_policy_id":{"type":"string","format":"uuid"},"curbiq_token":{"type":"string"}}}}},"pages":{"type":"object","properties":{"total":{"type":"integer"},"current":{"type":"integer"}}},"data":{"type":"array","items":{"type":"object","properties":{"policies":{"type":"array","items":{"type":"object","properties":{"curb_policy_id":{"type":"string","format":"uuid"},"published_date":{"type":"integer"},"priority":{"type":"integer"},"data_source_operator_id":{"type":["string","null"]},"timespans":{"type":"array","items":{"type":"object","properties":{"days_of_week":{"type":"array","items":{"type":"string"}},"months":{"type":"array","items":{"type":["string","null"]}},"days_of_month":{"type":"array","items":{"type":["string","null"]}},"time_of_day_start":{"type":"string"},"time_of_day_end":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":["string","null"]},"designated_period":{"type":["string","null"]}}}},"rules":{"type":"array","items":{"type":"object","properties":{"activity":{"type":"string"},"max_stay":{"type":["number","null"]},"max_stay_unit":{"type":"string"},"no_return":{"type":["number","null"]},"no_return_unit":{"type":"string"},"user_classes":{"type":"array","items":{"type":["string","null"]}},"rate":{"type":"object","properties":{"rate":{"type":["number","null"]},"rate_unit":{"type":"string"},"rate_unit_period":{"type":"string"}}}}}}}}}}}}}}}}},"400":{"description":"Request failed."}},"tags":["curbs"]}}}}
```