{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-activity-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_activity_list","summary":"Get the activity stream of an organization","description":"GET /action/organization_activity_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The id or name of the organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-activity-list-html":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_activity_list_html","summary":"Get the activity stream of an organization, HTML format","description":"GET /action/organization_activity_list_html","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The id or name of the organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-autocomplete":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_autocomplete","summary":"Get names of organizations that match a query string","description":"GET /action/organization_autocomplete","tags":["open-data"],"parameters":[{"name":"q","in":"query","required":false,"description":"The string to search for","schema":{"type":"string","default":"ministry","description":"The string to search for"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of organizations to return (optional)","schema":{"type":"integer","default":20,"description":"The maximum number of organizations to return (optional)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-follower-count":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_follower_count","summary":"Get number of followers of an organization","description":"GET /action/organization_follower_count","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The id or name of the organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-follower-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_follower_list","summary":"Get users following an organization","description":"GET /action/organization_follower_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The id or name of the organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_list","summary":"Get names of all organizations","description":"GET /action/organization_list","tags":["open-data"],"parameters":[{"name":"offset","in":"query","required":false,"description":"The offset (index) of the first organizations to return","schema":{"type":"integer","default":0,"description":"The offset (index) of the first organizations to return"}},{"name":"limit","in":"query","required":false,"description":"The number of organizations to be returned per page","schema":{"type":"integer","default":100,"description":"The number of organizations to be returned per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-list-for-user":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_list_for_user","summary":"Get organizations that a user has a given permission for","description":"GET /action/organization_list_for_user","tags":["open-data"],"parameters":[{"name":"permission","in":"query","required":false,"description":"The permission the user has against the returned organization","schema":{"type":"string","default":"\"edit_group\"","description":"The permission the user has against the returned organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-revision-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_revision_list","summary":"Get organization revisions","description":"GET /action/organization_revision_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The name or id of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The name or id of the organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-organization-show":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_organization_show","summary":"Get details of a specific organization","description":"GET /action/organization_show","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the organization","schema":{"type":"string","default":"ministry-of-agriculture","description":"The id or name of the organization"}},{"name":"include_datasets","in":"query","required":false,"description":"include a list of the organization's datasets","schema":{"type":"boolean","default":true,"description":"include a list of the organization's datasets"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-activity-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_activity_list","summary":"Get the activity stream of a package (dataset)","description":"GET /action/package_activity_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the package","schema":{"type":"string","default":"grizzly-bear-population-units","description":"The id or name of the package"}},{"name":"offset","in":"query","required":false,"description":"Where to start getting activity items from","schema":{"type":"integer","default":0,"description":"Where to start getting activity items from"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of activities to return","schema":{"type":"integer","default":31,"description":"The maximum number of activities to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-activity-list-html":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_activity_list_html","summary":"Get the activity stream of a package (dataset), HTML format","description":"GET /action/package_activity_list_html","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the package","schema":{"type":"string","default":"grizzly-bear-population-units","description":"The id or name of the package"}},{"name":"offset","in":"query","required":false,"description":"Where to start getting activity items from","schema":{"type":"integer","default":0,"description":"Where to start getting activity items from"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of activities to return","schema":{"type":"integer","default":31,"description":"The maximum number of activities to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-autocomplete":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_autocomplete","summary":"Find packages (datasets) matching a query","description":"GET /action/package_autocomplete","tags":["open-data"],"parameters":[{"name":"q","in":"query","required":false,"description":"The string to query","schema":{"type":"string","default":"\"Okanagan Lake\"","description":"The string to query"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of resource formats to return","schema":{"type":"integer","default":10,"description":"The maximum number of resource formats to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_list","summary":"Get a list of all packages (datasets)","description":"GET /action/package_list","tags":["open-data"],"parameters":[{"name":"offset","in":"query","required":false,"description":"The offset (index) of the first package to return","schema":{"type":"integer","default":0,"description":"The offset (index) of the first package to return"}},{"name":"limit","in":"query","required":false,"description":"The number of packages to be returned per page","schema":{"type":"integer","default":100,"description":"The number of packages to be returned per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-relationships-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_relationships_list","summary":"Get package (dataset) relationships","description":"GET /action/package_relationships_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the first package","schema":{"type":"string","default":"grizzly-bear-population-units","description":"The id or name of the first package"}},{"name":"id2","in":"query","required":false,"description":"The id or name of the second package","schema":{"type":"string","default":"important-fossil-areas","description":"The id or name of the second package"}},{"name":"rel","in":"query","required":false,"description":"relationship as string","schema":{"type":"string","description":"relationship as string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-revision-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_revision_list","summary":"Get list of revisions for a package (dataset)","description":"GET /action/package_revision_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id or name of the dataset","schema":{"type":"string","default":"grizzly-bear-population-units","description":"The id or name of the dataset"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-search":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_search","summary":"Find packages (datasets) matching query terms","description":"GET /action/package_search","tags":["open-data"],"parameters":[{"name":"q","in":"query","required":false,"description":"A query string","schema":{"type":"string","default":"\"Okanagan Lake\"","description":"A query string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-package-show":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_package_show","summary":"Get metadata about one specific package (dataset)","description":"GET /action/package_show","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The package name","schema":{"type":"string","default":"grizzly-bear-population-units","description":"The package name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-related-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_related_list","summary":"Gets items related to a package (dataset)","description":"GET /action/related_list","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"id or name of the dataset (optional)","schema":{"type":"string","description":"id or name of the dataset (optional)"}},{"name":"dataset","in":"query","required":false,"description":"Dataset dictionary of the dataset (optional)","schema":{"type":"string","description":"Dataset dictionary of the dataset (optional)"}},{"name":"type_filter","in":"query","required":false,"description":"The type of related item to show (optional)","schema":{"type":"string","description":"The type of related item to show (optional)"}},{"name":"sort","in":"query","required":false,"description":"The order to sort the related items in","schema":{"type":"string","description":"The order to sort the related items in"}},{"name":"featured","in":"query","required":false,"description":"whether or not to restrict the results to only featured items","schema":{"type":"string","description":"whether or not to restrict the results to only featured items"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-resource-search":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_resource_search","summary":"Find resources","description":"GET /action/resource_search","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"The search criteria string or list of strings of the form ``{field}:{term1}``","schema":{"type":"string","default":"format:csv","description":"The search criteria string or list of strings of the form ``{field}:{term1}``"}},{"name":"fields","in":"query","required":false,"description":"Depreciated","schema":{"type":"string","description":"Depreciated"}},{"name":"order_by","in":"query","required":false,"description":"A field on the resource model that orders the results","schema":{"type":"string","description":"A field on the resource model that orders the results"}},{"name":"offset","in":"query","required":false,"description":"Apply an offset to the query","schema":{"type":"integer","default":0,"description":"Apply an offset to the query"}},{"name":"limit","in":"query","required":false,"description":"Apply a limit to the query","schema":{"type":"integer","default":0,"description":"Apply a limit to the query"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-resource-show":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_resource_show","summary":"Get metadata for a specific resource","description":"GET /action/resource_show","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The id of the resource","schema":{"type":"string","default":"e6c8bb1d-3726-418b-9b7e-1d97a9bbb817","description":"The id of the resource"}},{"name":"include_tracking","in":"query","required":false,"description":"Add tracking information to dataset","schema":{"type":"boolean","default":false,"description":"Add tracking information to dataset"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-status-show":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_status_show","summary":"Get the site status","description":"GET /action/status_show","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-bcdc/get-action-tag-list":{"get":{"operationId":"open_data_gov_bc_ca_bcdc_get_action_tag_list","summary":"Get a list of tags","description":"GET /action/tag_list","tags":["open-data"],"parameters":[{"name":"offset","in":"query","required":false,"description":"The offset (index) of the first tag to return","schema":{"type":"integer","default":0,"description":"The offset (index) of the first tag to return"}},{"name":"limit","in":"query","required":false,"description":"The number of tags to be returned per page","schema":{"type":"integer","default":100,"description":"The number of tags to be returned per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}