{ "components": { "schemas": { "Action": { "properties": { "id": { "example": 1, "type": "integer" } }, "type": "object" }, "AllowedGrants": { "items": { "example": "authorization_code", "type": "string" }, "type": "array" }, "AssignedRoute": { "properties": { "assignment_id": { "example": "abc123", "type": "string" }, "id": { "example": "abc123", "type": "string" }, "route_id": { "example": "abc123", "type": "string" } }, "type": "object" }, "BlockAttributes": { "properties": { "button": { "$ref": "#/components/schemas/AssignedRoute" } }, "type": "object" }, "Bychangedfield": { "properties": {}, "type": "object" }, "Byinitializedfield": { "properties": { "email": { "example": 1, "type": "integer" }, "extra_text": { "example": 1, "type": "integer" }, "phone": { "example": 1, "type": "integer" } }, "type": "object" }, "Byorg": { "properties": { "household_id": { "example": 1, "type": "integer" }, "state": { "example": 1, "type": "integer" } }, "type": "object" }, "Bytag": { "properties": { "1": { "example": 1, "type": "integer" }, "13": { "example": 1, "type": "integer" }, "2": { "example": 1, "type": "integer" }, "4": { "example": 1, "type": "integer" }, "9": { "example": 1, "type": "integer" } }, "type": "object" }, "Children": { "items": { "$ref": "#/components/schemas/Type#8" }, "type": "array" }, "Children#2": { "items": { "$ref": "#/components/schemas/Type#9" }, "type": "array" }, "Children#3": { "items": { "$ref": "#/components/schemas/Type#10" }, "type": "array" }, "Config": { "properties": { "after": { "example": "now", "type": "string" }, "campaign": { "example": 1, "type": "integer" }, "operator": { "example": "in", "type": "string" } }, "type": "object" }, "Config#2": { "properties": { "config": { "$ref": "#/components/schemas/Error" }, "type": { "example": "campaign_participation", "type": "string" } }, "type": "object" }, "Config#3": { "properties": { "config": { "$ref": "#/components/schemas/Bychangedfield" }, "domain": { "example": "example.com", "type": "string" }, "id": { "example": 1, "type": "integer" }, "no_reply": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "sender_email": { "example": "sender@example.com", "type": "string" }, "sender_name": { "example": "Example sender", "type": "string" } }, "type": "object" }, "Config#4": { "properties": { "after": { "example": "1857-07-05", "type": "string" }, "before": { "example": "1857-07-05", "type": "string" }, "campaign": { "example": 1, "type": "integer" }, "email": { "example": 1, "type": "integer" }, "links": { "$ref": "#/components/schemas/Organizations" }, "operator": { "example": "not_blacklisted", "type": "string" }, "organizations": { "$ref": "#/components/schemas/Organizations" }, "reason": { "example": "unsub_org", "type": "string" } }, "type": "object" }, "Config#5": { "properties": { "ancestorOrganizations": { "$ref": "#/components/schemas/Organizations" }, "operator": { "example": "in", "type": "string" }, "organizations": { "$ref": "#/components/schemas/Organizations" }, "view": { "example": 1, "type": "integer" } }, "type": "object" }, "Config#6": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#7" } }, "type": "object" }, "Data": { "properties": { "id": { "example": 1, "type": "integer" }, "info_text": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Hand out flyers", "type": "string" } }, "type": "object" }, "Data#10": { "items": { "$ref": "#/components/schemas/Type#6" }, "type": "array" }, "Data#11": { "properties": { "dismissed": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "duplicates": { "$ref": "#/components/schemas/Duplicates" }, "id": { "example": 1, "type": "integer" }, "merged": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "status": { "example": "pending", "type": "string" } }, "type": "object" }, "Data#12": { "properties": { "config": { "$ref": "#/components/schemas/Error" }, "domain": { "example": "example.com", "type": "string" }, "id": { "example": 1, "type": "integer" }, "no_reply": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "sender_email": { "example": "mock@example.org", "type": "string" }, "sender_name": { "example": "Mock organization", "type": "string" } }, "type": "object" }, "Data#13": { "properties": { "block_attributes": { "$ref": "#/components/schemas/Bychangedfield" }, "css": { "example": "", "type": "string" }, "frame_mjml": { "type": "null" }, "id": { "example": 1, "type": "integer" } }, "type": "object" }, "Data#14": { "properties": { "accept_time": { "type": "null" }, "accepting_official": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_accepted": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "request_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "user_id": { "example": 1, "type": "integer" } }, "type": "object" }, "Data#15": { "properties": { "description": { "example": "", "type": "string" }, "id": { "example": 1, "type": "integer" }, "opening_note_template": { "example": "", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "plural_label": { "example": "Cases", "type": "string" }, "singular_label": { "example": "Case", "type": "string" }, "stats": { "$ref": "#/components/schemas/Byorg" }, "title": { "example": "Case", "type": "string" } }, "type": "object" }, "Data#16": { "properties": { "completed": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "deadline": { "type": "null" }, "description": { "example": "", "type": "string" }, "id": { "example": 1, "type": "integer" }, "title": { "example": "Evidence collected", "type": "string" } }, "type": "object" }, "Data#17": { "properties": { "author": { "$ref": "#/components/schemas/Organization" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "files": { "$ref": "#/components/schemas/FilterSpec" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "text": { "example": "This is my note", "type": "string" } }, "type": "object" }, "Data#18": { "properties": { "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Dorfplatz", "type": "string" } }, "type": "object" }, "Data#19": { "items": { "$ref": "#/components/schemas/Type#14" }, "type": "array" }, "Data#2": { "items": { "$ref": "#/components/schemas/Data" }, "type": "array" }, "Data#20": { "properties": { "client_id": { "example": "abc123", "type": "string" }, "grant": { "example": "***-OXm1Adsv2e6CTQs", "type": "string" }, "id": { "example": 1, "type": "integer" }, "ip_whitelist": { "$ref": "#/components/schemas/AllowedGrants" }, "scope": { "$ref": "#/components/schemas/AllowedGrants" } }, "type": "object" }, "Data#21": { "properties": { "assigned": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assignee": { "$ref": "#/components/schemas/Config" }, "completed": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "status": { "example": "completed", "type": "string" }, "task": { "$ref": "#/components/schemas/Task" } }, "type": "object" }, "Data#22": { "items": { "$ref": "#/components/schemas/Type#15" }, "type": "array" }, "Data#3": { "properties": { "id": { "example": 1, "type": "integer" }, "info_text": { "example": "info", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "New activity", "type": "string" } }, "type": "object" }, "Data#4": { "properties": { "city": { "type": "null" }, "country": { "type": "null" }, "household_count": { "example": 1, "type": "integer" }, "id": { "example": "abc123", "type": "string" }, "info_text": { "type": "null" }, "latitude": { "example": 1.0, "type": "number" }, "longitude": { "example": 1.0, "type": "number" }, "number": { "example": "2", "type": "string" }, "organization": { "$ref": "#/components/schemas/Error#2" }, "region": { "type": "null" }, "street": { "example": "Av 1", "type": "string" }, "suffix": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "Data#5": { "items": { "$ref": "#/components/schemas/Type" }, "type": "array" }, "Data#6": { "items": { "$ref": "#/components/schemas/Data#3" }, "type": "array" }, "Data#7": { "properties": { "assignment": { "$ref": "#/components/schemas/Error#2" }, "canvasser": { "$ref": "#/components/schemas/Organization" }, "id": { "example": "abc123", "type": "string" }, "route": { "$ref": "#/components/schemas/Route" } }, "type": "object" }, "Data#8": { "items": { "$ref": "#/components/schemas/Type#2" }, "type": "array" }, "Data#9": { "properties": { "archived": { "example": 1, "type": "integer" }, "cover_file": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "type": "null" }, "manager": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": 1, "type": "integer" }, "title": { "example": "abc123", "type": "string" }, "visibility": { "example": "hidden", "type": "string" } }, "type": "object" }, "Duplicates": { "items": { "$ref": "#/components/schemas/Type#7" }, "type": "array" }, "EnumChoices": { "items": { "$ref": "#/components/schemas/Error#2" }, "type": "array" }, "Error": { "properties": { "title": { "example": "404 Not Found", "type": "string" } }, "type": "object" }, "Error#2": { "properties": { "description": { "example": "", "type": "string" }, "title": { "example": "401 Unauthorized", "type": "string" } }, "type": "object" }, "Field": { "properties": { "description": { "example": "Contains arbitrary extra data as JSON", "type": "string" }, "enum_choices": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "org_read": { "example": "sameorg", "type": "string" }, "org_write": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "slug": { "example": "extra_data", "type": "string" }, "title": { "example": "Extra data", "type": "string" }, "type": { "example": "json", "type": "string" } }, "type": "object" }, "FilterSpec": { "type": "array" }, "FilterSpec#2": { "items": { "$ref": "#/components/schemas/Type#3" }, "type": "array" }, "FilterSpec#3": { "items": { "$ref": "#/components/schemas/Type#4" }, "type": "array" }, "FilterSpec#4": { "items": { "$ref": "#/components/schemas/Type#5" }, "type": "array" }, "FilterSpec#5": { "items": { "$ref": "#/components/schemas/Error" }, "type": "array" }, "FilterSpec#6": { "items": { "$ref": "#/components/schemas/Type#12" }, "type": "array" }, "FilterSpec#7": { "items": { "$ref": "#/components/schemas/Type#13" }, "type": "array" }, "FrameMjml": { "properties": { "attributes": { "$ref": "#/components/schemas/Error" }, "children": { "$ref": "#/components/schemas/Children#3" }, "tagName": { "example": "mj-wrapper", "type": "string" } }, "type": "object" }, "Location": { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" } }, "type": "object" }, "NextMilestone": { "properties": { "completed": { "type": "null" }, "deadline": { "type": "null" }, "description": { "example": "", "type": "string" }, "id": { "example": 1, "type": "integer" }, "title": { "example": "Evidence collected", "type": "string" } }, "type": "object" }, "NumBlocked": { "properties": { "num_booked": { "example": 1, "type": "integer" }, "num_pending": { "example": 1, "type": "integer" }, "num_reminded": { "example": 1, "type": "integer" }, "num_signups": { "example": 1, "type": "integer" } }, "type": "object" }, "Organization": { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "My Organization", "type": "string" } }, "type": "object" }, "Organizations": { "items": { "example": 1, "type": "integer" }, "type": "array" }, "PersonData": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "anyOf": [ { "type": "null" }, { "example": "clara@example.com", "type": "string" } ] }, "ext_id": { "type": "null" }, "first_name": { "example": "Clara", "type": "string" }, "gender": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "type": "null" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "Problems": { "items": { "$ref": "#/components/schemas/User" }, "type": "array" }, "Question": { "properties": { "config": { "$ref": "#/components/schemas/Error#2" }, "type": { "example": "call_history", "type": "string" } }, "type": "object" }, "Route": { "properties": { "household_count": { "example": 1, "type": "integer" }, "id": { "example": "abc123", "type": "string" }, "info_text": { "type": "null" }, "title": { "type": "null" } }, "type": "object" }, "Subjects": { "items": { "$ref": "#/components/schemas/Config" }, "type": "array" }, "Tags": { "items": { "$ref": "#/components/schemas/Organization" }, "type": "array" }, "Tags#2": { "items": { "$ref": "#/components/schemas/Type#11" }, "type": "array" }, "Target": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#2" }, "id": { "example": 1, "type": "integer" }, "type": { "example": "callassignment_target", "type": "string" } }, "type": "object" }, "Target#2": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#3" }, "id": { "example": 1, "type": "integer" }, "type": { "example": "callassignment_target", "type": "string" } }, "type": "object" }, "Target#3": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#4" }, "id": { "example": 1, "type": "integer" }, "type": { "example": "callassignment_target", "type": "string" } }, "type": "object" }, "Target#4": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec" }, "id": { "example": 1, "type": "integer" } }, "type": "object" }, "Target#5": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#5" }, "id": { "example": 1, "type": "integer" } }, "type": "object" }, "TargetFilters": { "items": { "$ref": "#/components/schemas/Question" }, "type": "array" }, "Task": { "properties": { "campaign": { "type": "null" }, "config": { "$ref": "#/components/schemas/Bychangedfield" }, "cover_file": { "type": "null" }, "deadline": { "type": "null" }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "Dummy task instructions", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "time_estimate": { "type": "null" }, "title": { "example": "Dummy task", "type": "string" }, "type": { "example": "offline", "type": "string" } }, "type": "object" }, "Type": { "properties": { "address": { "$ref": "#/components/schemas/Error#2" }, "id": { "example": "abc123", "type": "string" }, "label": { "type": "null" } }, "type": "object" }, "Type#10": { "properties": { "attributes": { "$ref": "#/components/schemas/Bychangedfield" }, "children": { "$ref": "#/components/schemas/Children#2" }, "tagName": { "example": "mj-section", "type": "string" } }, "type": "object" }, "Type#11": { "properties": { "color": { "type": "null" }, "description": { "example": "", "type": "string" }, "group": { "$ref": "#/components/schemas/Organization" }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Activist", "type": "string" }, "value": { "type": "null" }, "value_type": { "type": "null" } }, "type": "object" }, "Type#12": { "properties": { "config": { "$ref": "#/components/schemas/Config#4" }, "id": { "example": "1", "type": "string" }, "op": { "example": "add", "type": "string" }, "type": { "example": "all", "type": "string" } }, "type": "object" }, "Type#13": { "properties": { "config": { "$ref": "#/components/schemas/Bychangedfield" }, "op": { "example": "add", "type": "string" }, "type": { "example": "task", "type": "string" } }, "type": "object" }, "Type#14": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "example": "testadmin@example.com", "type": "string" }, "ext_id": { "type": "null" }, "first_name": { "example": "Angela", "type": "string" }, "gender": { "example": "f", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Davis", "type": "string" }, "phone": { "example": "+4675463729", "type": "string" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "Type#15": { "properties": { "follow": { "example": 1, "type": "integer" }, "inherited": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "profile": { "$ref": "#/components/schemas/Organization" }, "role": { "example": "admin", "type": "string" } }, "type": "object" }, "Type#2": { "properties": { "address": { "$ref": "#/components/schemas/Error#2" }, "allocation_time": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assigned_route": { "$ref": "#/components/schemas/AssignedRoute" }, "household_id": { "example": "abc123", "type": "string" }, "id": { "example": "abc123", "type": "string" }, "state": { "example": 1, "type": "integer" }, "visit_time": { "type": "null" }, "visitor": { "type": "null" } }, "type": "object" }, "Type#3": { "properties": { "config": { "$ref": "#/components/schemas/Config" }, "type": { "example": "campaign_participation", "type": "string" } }, "type": "object" }, "Type#4": { "properties": { "config": { "$ref": "#/components/schemas/Organization" }, "type": { "example": "call_history", "type": "string" } }, "type": "object" }, "Type#5": { "properties": { "config": { "$ref": "#/components/schemas/Organization" }, "op": { "example": "add", "type": "string" }, "type": { "example": "sub_query", "type": "string" } }, "type": "object" }, "Type#6": { "properties": { "campaign": { "$ref": "#/components/schemas/Organization" }, "config": { "$ref": "#/components/schemas/Bychangedfield" }, "cover_file": { "type": "null" }, "deadline": { "type": "null" }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "Dummy task instructions", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "reassign_interval": { "type": "null" }, "reassign_limit": { "type": "null" }, "target": { "$ref": "#/components/schemas/Target#5" }, "time_estimate": { "type": "null" }, "title": { "example": "Dummy task", "type": "string" }, "type": { "example": "offline", "type": "string" } }, "type": "object" }, "Type#7": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "type": "null" }, "ext_id": { "type": "null" }, "first_name": { "example": "Clara", "type": "string" }, "gender": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "type": "null" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "Type#8": { "properties": { "attributes": { "$ref": "#/components/schemas/Bychangedfield" }, "tagName": { "example": "placeholder", "type": "string" } }, "type": "object" }, "Type#9": { "properties": { "attributes": { "$ref": "#/components/schemas/Bychangedfield" }, "children": { "$ref": "#/components/schemas/Children" }, "tagName": { "example": "mj-column", "type": "string" } }, "type": "object" }, "User": { "properties": { "email": { "example": "testadmin@example.com", "type": "string" }, "first_name": { "example": "Angela", "type": "string" }, "id": { "example": 1, "type": "integer" }, "last_name": { "example": "Davis", "type": "string" } }, "type": "object" }, "User#2": { "properties": { "email": { "example": "testuser@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Jane", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_verified": { "example": 1, "type": "integer" }, "joined": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "lang": { "type": "null" }, "last_login": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "last_name": { "example": "Doe", "type": "string" }, "phone": { "type": "null" }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" }, "Visits": { "items": { "$ref": "#/components/schemas/Byorg" }, "type": "array" } } }, "info": { "contact": { "email": "info@zetkin.org", "name": "Zetkin Foundation", "url": "https://zetkin.org/en" }, "description": "Note: campaign = project, action = event, activity = category", "title": "Zetkin API Docs", "version": "Core 1" }, "openapi": "3.1.1", "paths": { "/api_clients": { "get": { "deprecated": false, "description": "", "operationId": "get--api_clients", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "allowed_grants": ["authorization_code"], "allowed_origins": ["http://call.dev.zetkin.org"], "allowed_redirect_uris": ["http://call.dev.zetkin.org/"], "created": "1857-07-05T00:00:00.000000", "id": "abc123", "owner": "Zetkin Foundation", "refresh_token_ttl": null, "secret": "abc123", "title": "Dev" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "allowed_grants": { "$ref": "#/components/schemas/AllowedGrants" }, "allowed_origins": { "$ref": "#/components/schemas/AllowedGrants" }, "allowed_redirect_uris": { "$ref": "#/components/schemas/AllowedGrants" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": "abc123", "type": "string" }, "owner": { "example": "Zetkin Foundation", "type": "string" }, "refresh_token_ttl": { "type": "null" }, "secret": { "example": "abc123", "type": "string" }, "title": { "example": "Dev", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get api client", "tags": [] } }, "/api_clients/{client_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--api_clients-{client_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "abc123", "in": "path", "name": "client_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete api client", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--api_clients-{client_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "abc123", "in": "path", "name": "client_id", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get api client", "tags": [] } }, "/orgs": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "avatar_file": null, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": null, "parent": null, "phone": null, "short_title": null, "slug": "myorg", "title": "My Organization" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "type": "null" }, "parent": { "type": "null" }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "example": "myorg", "type": "string" }, "title": { "example": "My Organization", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get org", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs", "requestBody": { "content": { "application/json": { "example": { "country": "SE", "email": "myneworg@example.com", "is_active": 1, "is_open": 1, "is_public": 1, "lang": "sv", "location": { "lat": 1.0, "lng": 1.0 }, "phone": "+46 701 23 45 67", "short_title": "New org", "slug": "my-new-organization", "title": "My new organization" }, "schema": { "properties": { "country": { "example": "SE", "type": "string" }, "email": { "example": "myneworg@example.com", "type": "string" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "example": "sv", "type": "string" }, "location": { "$ref": "#/components/schemas/Location" }, "phone": { "example": "+46 701 23 45 67", "type": "string" }, "short_title": { "example": "New org", "type": "string" }, "slug": { "example": "my-new-organization", "type": "string" }, "title": { "example": "My new organization", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "avatar_file": null, "country": "SE", "email": "myneworg@example.com", "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": "sv", "location": { "lat": 1.0, "lng": 1.0 }, "parent": null, "phone": "+46 701 23 45 67", "short_title": "New org", "slug": "my-new-organization", "title": "My new organization" } }, "schema": { "properties": { "data": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "example": "myneworg@example.com", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "example": "sv", "type": "string" }, "location": { "$ref": "#/components/schemas/Location" }, "parent": { "type": "null" }, "phone": { "example": "+46 701 23 45 67", "type": "string" }, "short_title": { "example": "New org", "type": "string" }, "slug": { "example": "my-new-organization", "type": "string" }, "title": { "example": "My new organization", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post org", "tags": ["Organizations"] } }, "/orgs/{org_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete org", "tags": ["Organizations"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "avatar_file": null, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": { "lat": 1.0, "lng": 1.0 }, "parent": null, "phone": null, "short_title": null, "slug": "myorg", "title": "example_string" } }, "schema": { "properties": { "data": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "anyOf": [ { "type": "null" }, { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" } }, "type": "object" } ] }, "parent": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "slug": { "example": "myorg", "type": "string" }, "title": { "example": "My Organization", "type": "string" } }, "type": "object" } ] }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "anyOf": [ { "example": "myorg", "type": "string" }, { "type": "null" } ] }, "title": { "example": "My Organization", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get org", "tags": ["Organizations"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "avatar_file_id": 1 }, "schema": { "properties": { "avatar_file_id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "location": { "anyOf": [ { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" } }, "type": "object" }, { "type": "null" } ] }, "parent_id": { "example": 1, "type": "integer" }, "title": { "example": "example_string", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "avatar_file": { "id": 1, "mime_type": "image/png", "organization": { "id": 1, "title": "My Unrelated Organization" }, "original_name": "dummy.png", "uploaded": "1857-07-05T00:00:00.000000", "url": "http://files.dev.zetkin.org/5/dummy.png" }, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": null, "parent": null, "phone": null, "short_title": null, "slug": "myunrelorg", "title": "My Unrelated Organization" } }, "schema": { "properties": { "data": { "properties": { "avatar_file": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "mime_type": { "example": "image/png", "type": "string" }, "organization": { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "My Unrelated Organization", "type": "string" } }, "type": "object" }, "original_name": { "example": "dummy.png", "type": "string" }, "uploaded": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "url": { "example": "http://files.dev.zetkin.org/5/dummy.png", "type": "string" } }, "type": "object" } ] }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "anyOf": [ { "type": "null" }, { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" } }, "type": "object" } ] }, "parent": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "slug": { "example": "myunrelorg", "type": "string" }, "title": { "example": "My Unrelated Organization", "type": "string" } }, "type": "object" } ] }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "anyOf": [ { "type": "null" }, { "example": "myorg", "type": "string" } ] }, "title": { "example": "Inactive parent", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid parent" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch org", "tags": ["Organizations"] } }, "/orgs/{org_id}/actions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "activity": null, "campaign": null, "cancelled": null, "cancelled_by_user": null, "contact": null, "cover_file": null, "end_time": "1857-07-05T00:00:00.000000+0000", "id": 1, "info_text": "", "location": null, "num_participants_available": 1, "num_participants_required": 1, "organization": { "id": 1, "title": "My Organization" }, "published": "1857-07-05T00:00:00.000000+0000", "published_by_user": null, "start_time": "1857-07-05T00:00:00.000000+0000", "title": null, "url": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "activity": { "type": "null" }, "campaign": { "type": "null" }, "cancelled": { "type": "null" }, "cancelled_by_user": { "type": "null" }, "contact": { "type": "null" }, "cover_file": { "type": "null" }, "end_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "location": { "type": "null" }, "num_participants_available": { "example": 1, "type": "integer" }, "num_participants_required": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "published_by_user": { "type": "null" }, "start_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "title": { "type": "null" }, "url": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"start_time\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post action", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-actions-{action_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete action", "tags": ["Campaign"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action", "tags": ["Campaign"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-actions-{action_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "contact_id": "1" }, "schema": { "properties": { "activity_id": { "type": "null" }, "cancelled": { "type": "null" }, "contact_id": { "anyOf": [ { "example": "1", "type": "string" }, { "example": 1, "type": "integer" }, { "type": "null" } ] }, "cover_file_id": { "anyOf": [ { "type": "null" }, { "example": 1, "type": "integer" } ] }, "location_id": { "type": "null" }, "published": { "type": "null" }, "unknown_prop": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch action", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/cover": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-cover", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action item cover", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/participants": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-participants", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action participant", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/participants/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-actions-{action_id}-participants-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete action participant", "tags": ["Campaign"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-participants-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action participant", "tags": ["Campaign"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-actions-{action_id}-participants-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "attended" }, "schema": { "properties": { "status": { "example": "attended", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'invalid': 'invalid'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put action participant", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/reminders": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-reminders", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action reminder", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-actions-{action_id}-reminders", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "202": { "content": { "application/json": { "example": { "data": [ { "action": { "id": 1 }, "person": { "id": 1, "name": "First Last" }, "sent": "1857-07-05T00:00:00.000000+0000" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "action": { "$ref": "#/components/schemas/Action" }, "person": { "$ref": "#/components/schemas/Organization" }, "sent": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 202" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'remind_all' error:\n'invalid data' should be instance of 'bool'\" parameter is invalid. Key 'remind_all' error:\n'invalid data' should be instance of 'bool'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "Cannot send reminders when action contact is undefined", "title": "Missing contact" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post action reminder", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/responses": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-responses", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action response", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/responses/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-actions-{action_id}-responses-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete action response", "tags": ["Campaign"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-responses-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action response", "tags": ["Campaign"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-actions-{action_id}-responses-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put action response", "tags": ["Campaign"] } }, "/orgs/{org_id}/actions/{action_id}/stats": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-actions-{action_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "action_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "num_booked": 1, "num_pending": 1, "num_reminded": 1, "num_signups": 1 } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/NumBlocked" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get action stats", "tags": ["Campaign"] } }, "/orgs/{org_id}/activities": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-activities", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "info_text": null, "organization": { "id": 1, "title": "My Organization" }, "title": "Put up posters" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#2" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get activity", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-activities", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "info", "title": "New activity" }, "schema": { "properties": { "info_text": { "example": "info", "type": "string" }, "title": { "example": "New activity", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "info_text": "info", "organization": { "id": 1, "title": "My Organization" }, "title": "New activity" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#3" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post activity", "tags": ["Campaign"] } }, "/orgs/{org_id}/activities/{activity_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-activities-{activity_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "activity_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete activity", "tags": ["Campaign"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-activities-{activity_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "activity_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get activity", "tags": ["Campaign"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-activities-{activity_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "activity_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "New info text", "title": "New title" }, "schema": { "properties": { "info_text": { "example": "New info text", "type": "string" }, "invalid_prop": { "example": "value", "type": "string" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch activity", "tags": ["Campaign"] } }, "/orgs/{org_id}/addresses": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-addresses", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "city": null, "country": null, "household_count": 1, "id": "mGHAP", "info_text": null, "latitude": 1.0, "longitude": 1.0, "number": "3", "organization": { "id": "abc123", "title": "My Organization" }, "region": null, "street": "Av 1", "suffix": null, "zip_code": null } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#4" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get address", "tags": ["Canvass"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-addresses", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "latitude": 1.0, "longitude": 1.0, "street": "Main Street" }, "schema": { "properties": { "latitude": { "example": 1.0, "type": "number" }, "longitude": { "example": 1.0, "type": "number" }, "street": { "example": "Main Street", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "city": null, "country": null, "household_count": 1, "id": "abc123", "info_text": null, "latitude": null, "longitude": null, "number": null, "organization": { "id": "abc123", "title": "My Organization" }, "region": null, "street": "Main Street", "suffix": null, "zip_code": null } }, "schema": { "properties": { "data": { "properties": { "city": { "type": "null" }, "country": { "type": "null" }, "household_count": { "example": 1, "type": "integer" }, "id": { "example": "abc123", "type": "string" }, "info_text": { "type": "null" }, "latitude": { "anyOf": [ { "type": "null" }, { "example": 1.0, "type": "number" } ] }, "longitude": { "anyOf": [ { "type": "null" }, { "example": 1.0, "type": "number" } ] }, "number": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Error#2" }, "region": { "type": "null" }, "street": { "example": "Main Street", "type": "string" }, "suffix": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post address", "tags": ["Canvass"] } }, "/orgs/{org_id}/addresses/{addr_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-addresses-{addr_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete address", "tags": ["Canvass"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-addresses-{addr_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "street": "Other street" }, "schema": { "properties": { "street": { "example": "Other street", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "city": null, "country": null, "household_count": 1, "id": "abc123", "info_text": null, "latitude": 1.0, "longitude": 1.0, "number": "2", "organization": { "id": "abc123", "title": "My Organization" }, "region": null, "street": "Av 1", "suffix": null, "zip_code": null } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#4" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get address", "tags": ["Canvass"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-addresses-{addr_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "longitude": 1, "street": "Other street" }, "schema": { "properties": { "latitude": { "example": 1, "type": "integer" }, "longitude": { "example": 1, "type": "integer" }, "street": { "example": "Other street", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "city": null, "country": null, "household_count": 1, "id": "abc123", "info_text": null, "latitude": 1.0, "longitude": 1.0, "number": "2", "organization": { "id": "abc123", "title": "My Organization" }, "region": null, "street": "Other street", "suffix": null, "zip_code": null } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#4" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch address", "tags": ["Canvass"] } }, "/orgs/{org_id}/addresses/{addr_id}/households": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-addresses-{addr_id}-households", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "address": { "id": "abc123", "street": "Other street" }, "id": "abc123", "label": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#5" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get address household", "tags": ["Canvass"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-addresses-{addr_id}-households", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "label": "A label" }, "schema": { "properties": { "label": { "example": "A label", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "address": { "id": "abc123", "street": "Other street" }, "id": "mHHPr", "label": "A label" } }, "schema": { "properties": { "data": { "properties": { "address": { "$ref": "#/components/schemas/Error#2" }, "id": { "example": "mHHPr", "type": "string" }, "label": { "anyOf": [ { "example": "A label", "type": "string" }, { "type": "null" } ] } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"unknown_attr\" parameter is invalid. Wrong key 'unknown_attr' in {'label': 'A label', 'unknown_attr': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post address household", "tags": ["Canvass"] } }, "/orgs/{org_id}/addresses/{addr_id}/tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-addresses-{addr_id}-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "info_text": "", "organization": { "id": 1, "title": "My Organization" }, "title": "North" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get address location tag", "tags": ["Canvass"] } }, "/orgs/{org_id}/addresses/{addr_id}/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-addresses-{addr_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete address location tag", "tags": ["Canvass"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-addresses-{addr_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "addr_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put address location tag", "tags": ["Canvass"] } }, "/orgs/{org_id}/assigned_routes": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-assigned_routes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assignment": { "id": "abc123", "title": "First assignment" }, "canvasser": { "id": 1, "name": "Rosa Luxemburg" }, "id": "abc123", "route": { "household_count": 1, "id": "abc123", "info_text": null, "title": null } } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#7" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get assigned route", "tags": ["Canvass"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-assigned_routes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "assignment_id": 1, "canvasser_id": 1, "route_id": 1 }, "schema": { "properties": { "assignment_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "example": "100000", "type": "string" } ] }, "canvasser_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "example": "100000", "type": "string" } ] }, "route_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "example": "100000", "type": "string" } ] } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "assignment": { "id": "abc123", "title": "First assignment" }, "canvasser": { "id": 1, "name": "Angela Davis" }, "id": "PDXzW", "route": { "household_count": 1, "id": "abc123", "info_text": null, "title": null } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#7" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'assignment_id': 1, 'route_id': 3, 'canvasser_id': 2, 'invalid': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "The route is already assigned in this assignment", "title": "Already assigned" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post assigned route", "tags": ["Canvass"] } }, "/orgs/{org_id}/assigned_routes/{route_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-assigned_routes-{route_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "route_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "assignment": { "id": "abc123", "title": "First assignment" }, "canvasser": { "id": 1, "name": "Rosa Luxemburg" }, "id": "abc123", "route": { "household_count": 1, "id": "abc123", "info_text": null, "title": null } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#7" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get assigned route", "tags": ["Canvass"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-assigned_routes-{route_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "route_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "canvasser_id": null }, "schema": { "properties": { "canvasser_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "assignment": { "id": "abc123", "title": "First assignment" }, "canvasser": null, "id": "abc123", "route": { "household_count": 1, "id": "abc123", "info_text": null, "title": null } } }, "schema": { "properties": { "data": { "properties": { "assignment": { "$ref": "#/components/schemas/Error#2" }, "canvasser": { "anyOf": [ { "properties": { "id": { "example": 1, "type": "integer" }, "name": { "example": "Angela Davis", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "id": { "example": "abc123", "type": "string" }, "route": { "$ref": "#/components/schemas/Route" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'canvasser_id': 2, 'invalid': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch assigned route", "tags": ["Canvass"] } }, "/orgs/{org_id}/assigned_routes/{route_id}/household_visits": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-assigned_routes-{route_id}-household_visits", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "route_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "address": { "address": "Other street 2", "id": "abc123" }, "allocation_time": "1857-07-05T00:00:00.000000", "assigned_route": { "assignment_id": "abc123", "id": "abc123", "route_id": "abc123" }, "household_id": "abc123", "id": "abc123", "state": 1, "visit_time": null, "visitor": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#8" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get assigned route household visit", "tags": ["Canvass"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-assigned_routes-{route_id}-household_visits", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "route_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "visits": [ { "household_id": 1, "state": 1 } ] }, "schema": { "properties": { "visits": { "$ref": "#/components/schemas/Visits" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "address": { "address": "Other street 2", "id": "abc123" }, "allocation_time": "1857-07-05T00:00:00.000000", "assigned_route": { "assignment_id": "abc123", "id": "abc123", "route_id": "abc123" }, "household_id": "mHHAP", "id": "mLHAP", "state": 1, "visit_time": null, "visitor": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "address": { "$ref": "#/components/schemas/Error#2" }, "allocation_time": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assigned_route": { "$ref": "#/components/schemas/AssignedRoute" }, "household_id": { "example": "abc123", "type": "string" }, "id": { "example": "abc123", "type": "string" }, "state": { "example": 1, "type": "integer" }, "visit_time": { "anyOf": [ { "example": "1857-07-05T00:00:00.000000", "type": "string" }, { "type": "null" } ] }, "visitor": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Incorrectly formatted data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post assigned route household visit", "tags": ["Canvass"] } }, "/orgs/{org_id}/assigned_routes/{route_id}/stats": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-assigned_routes-{route_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "route_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "num_households_allocated": 1, "num_households_visited": 1 } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Byorg" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get assigned route stats", "tags": ["Canvass"] } }, "/orgs/{org_id}/avatar": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-avatar", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "303": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 303" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get organization avatar", "tags": ["Organizations"] } }, "/orgs/{org_id}/bulk": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-bulk", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get bulk", "tags": ["People"] } }, "/orgs/{org_id}/bulk/execute": { "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-bulk-execute", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "ops": [ { "op": "person.create", "ops": [ { "data": { "field_in_other_org": "foo", "first_name": "Clara", "last_name": "Zetkin" }, "op": "person.setfields" } ] } ] }, "schema": { "properties": { "ops": { "items": { "properties": { "data": { "properties": { "email": { "example": "clara@zetk.in", "type": "string" }, "ext_id": { "example": "test_986775", "type": "string" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "extra_date": { "example": "1857-07-05", "type": "string" }, "extra_text": { "example": "bar", "type": "string" }, "field_in_other_org": { "example": "foo", "type": "string" }, "first_name": { "example": "Clara", "type": "string" }, "id": { "example": 1, "type": "integer" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "example": "+46123-456789", "type": "string" } }, "type": "object" }, "if_multiple": { "example": "all", "type": "string" }, "if_none": { "example": "skip", "type": "string" }, "key": { "$ref": "#/components/schemas/User" }, "op": { "example": "person.import", "type": "string" }, "ops": { "items": { "properties": { "data": { "properties": { "email": { "example": "clara@zetk.in", "type": "string" }, "ext_id": { "example": "test_986775", "type": "string" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "extra_date": { "example": "1857-07-05", "type": "string" }, "extra_text": { "example": "bar", "type": "string" }, "field_in_other_org": { "example": "foo", "type": "string" }, "first_name": { "example": "Clara", "type": "string" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "example": "+46123-456789", "type": "string" } }, "type": "object" }, "op": { "example": "person.setfields", "type": "string" }, "tag_id": { "example": 1, "type": "integer" }, "value": { "example": "New value", "type": "string" } }, "type": "object" }, "type": "array" }, "organizations": { "$ref": "#/components/schemas/Organizations" }, "tags": { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "value": { "anyOf": [ { "type": "null" }, { "example": "New value", "type": "string" } ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "accepted": "1857-07-05T00:00:00.000000", "completed": "1857-07-05T00:00:00.000000", "error": null, "id": 1, "organization": { "id": 1, "title": "My Fourth Organization" }, "report": { "person": { "summary": { "addedToOrg": { "byOrg": { "1": 1, "3": 1, "4": 1 }, "total": 1 }, "created": { "total": 1 }, "deleted": { "total": 1 }, "tagged": { "byTag": {}, "total": 1 }, "updated": { "byChangedField": {}, "byInitializedField": {}, "total": 1 } } } }, "status": "completed", "user": { "email": "abc123", "first_name": "Angela", "id": 1, "last_name": "Davis" } } }, "schema": { "properties": { "data": { "properties": { "accepted": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "completed": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "error": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "report": { "properties": { "person": { "properties": { "summary": { "properties": { "addedToOrg": { "properties": { "byOrg": { "properties": { "1": { "example": 1, "type": "integer" }, "10": { "example": 1, "type": "integer" }, "15": { "example": 1, "type": "integer" }, "2": { "example": 1, "type": "integer" }, "3": { "example": 1, "type": "integer" }, "4": { "example": 1, "type": "integer" } }, "type": "object" }, "total": { "example": 1, "type": "integer" } }, "type": "object" }, "created": { "$ref": "#/components/schemas/Action" }, "deleted": { "$ref": "#/components/schemas/Action" }, "tagged": { "properties": { "byTag": { "$ref": "#/components/schemas/Bytag" }, "total": { "example": 1, "type": "integer" } }, "type": "object" }, "updated": { "properties": { "byChangedField": { "$ref": "#/components/schemas/Bytag" }, "byInitializedField": { "$ref": "#/components/schemas/Byinitializedfield" }, "total": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "status": { "example": "completed", "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "data": { "error": { "message": "There are problems with the input ops" } } }, "schema": { "properties": { "data": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post bulk execute", "tags": ["People"] } }, "/orgs/{org_id}/bulk/preview": { "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-bulk-preview", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "ops": [ { "data": { "first_name": "Clara", "last_name": "Zetkin" }, "op": "person.import", "tags": [ { "id": 1 } ] } ] }, "schema": { "properties": { "ops": { "items": { "properties": { "data": { "properties": { "email": { "example": "clara@zetk.in", "type": "string" }, "ext_id": { "example": "test_986775", "type": "string" }, "extra_date": { "example": "1857-07-05", "type": "string" }, "extra_text": { "anyOf": [ { "example": "bar", "type": "string" }, { "example": 1, "type": "integer" } ] }, "first_name": { "example": "Clara", "type": "string" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "example": "+46123-456789", "type": "string" } }, "type": "object" }, "op": { "example": "person.import", "type": "string" }, "tags": { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "value": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "problems": [ { "code": "UNKNOWN_OBJECT", "field": "tag.id", "index": 1, "level": "error" } ], "stats": { "person": { "summary": { "addedToOrg": { "byOrg": { "1": 1 }, "total": 1 }, "created": { "total": 1 }, "deleted": { "total": 1 }, "tagged": { "byTag": { "999": 1 }, "total": 1 }, "updated": { "byChangedField": {}, "byInitializedField": {}, "total": 1 } } } } } }, "schema": { "properties": { "data": { "properties": { "problems": { "$ref": "#/components/schemas/Problems" }, "stats": { "properties": { "person": { "properties": { "summary": { "properties": { "addedToOrg": { "properties": { "byOrg": { "$ref": "#/components/schemas/Byorg" }, "total": { "example": 1, "type": "integer" } }, "type": "object" }, "created": { "$ref": "#/components/schemas/Action" }, "deleted": { "$ref": "#/components/schemas/Action" }, "tagged": { "properties": { "byTag": { "$ref": "#/components/schemas/Byinitializedfield" }, "total": { "example": 1, "type": "integer" } }, "type": "object" }, "updated": { "properties": { "byChangedField": { "$ref": "#/components/schemas/Bychangedfield" }, "byInitializedField": { "$ref": "#/components/schemas/Bychangedfield" }, "total": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post bulk preview", "tags": ["People"] } }, "/orgs/{org_id}/call_assignments": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "campaign": null, "cooldown": 1, "description": "This is a call assignment called First assignment", "disable_caller_notes": 1, "end_date": "1857-07-05", "expose_target_details": 1, "goal": { "filter_spec": [ { "config": { "after": "now", "campaign": 1, "operator": "in" }, "type": "campaign_participation" } ], "id": 1, "type": "callassignment_goal" }, "id": 1, "instructions": "Hello caller, Go ahead and call some people!", "organization": { "id": 1, "title": "My Organization" }, "start_date": "1857-07-05", "target": { "filter_spec": [ { "config": { "operator": "in" }, "type": "campaign_participation" } ], "id": 1, "type": "callassignment_target" }, "title": "First assignment" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "campaign": { "type": "null" }, "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "This is a call assignment called First assignment", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "expose_target_details": { "example": 1, "type": "integer" }, "goal": { "$ref": "#/components/schemas/Target" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "Hello caller, Go ahead and call some people!", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "start_date": { "example": "1857-07-05", "type": "string" }, "target": { "$ref": "#/components/schemas/Target" }, "title": { "example": "First assignment", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment", "tags": ["Call"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-call_assignments", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "cooldown": 1, "description": "My description", "end_date": "1857-07-05", "goal_filters": [ { "config": { "assignment": "$self", "operator": "reached" }, "type": "call_history" } ], "instructions": "My instructions", "start_date": "1857-07-05", "target_filters": [ { "config": { "assignment": "$self", "operator": "reached" }, "type": "call_history" } ], "title": "New call assignment" }, "schema": { "properties": { "campaign_id": { "example": 1, "type": "integer" }, "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "My description", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "expose_target_details": { "example": 1, "type": "integer" }, "goal_filters": { "$ref": "#/components/schemas/TargetFilters" }, "instructions": { "example": "My instructions", "type": "string" }, "start_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "target_filters": { "$ref": "#/components/schemas/TargetFilters" }, "title": { "example": "New call assignment", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "campaign": { "id": 1, "title": "First campaign in 1" }, "cooldown": 1, "description": "My description", "disable_caller_notes": 1, "end_date": "1857-07-05", "expose_target_details": 1, "goal": { "filter_spec": [], "id": 1, "type": "callassignment_goal" }, "id": 1, "instructions": "My instructions", "organization": { "id": 1, "title": "My Organization" }, "start_date": "1857-07-05", "target": { "filter_spec": [], "id": 1, "type": "callassignment_target" }, "title": "New call assignment" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "anyOf": [ { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "First campaign in 1", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "My description", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "expose_target_details": { "example": 1, "type": "integer" }, "goal": { "$ref": "#/components/schemas/Target#2" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "My instructions", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "start_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "target": { "$ref": "#/components/schemas/Target#2" }, "title": { "example": "New call assignment", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"target_filters\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post call assignment", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-call_assignments-{assignment_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete call assignment", "tags": ["Call"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "campaign": null, "cooldown": 1, "description": "This is a call assignment called First assignment", "disable_caller_notes": 1, "end_date": "1857-07-05", "expose_target_details": 1, "goal": { "filter_spec": [ { "config": { "after": "now", "campaign": 1, "operator": "in" }, "type": "campaign_participation" } ], "id": 1, "type": "callassignment_goal" }, "id": 1, "instructions": "Hello caller, Go ahead and call some people!", "organization": { "id": 1, "title": "My Organization" }, "start_date": "1857-07-05", "target": { "filter_spec": [ { "config": { "operator": "in" }, "type": "campaign_participation" } ], "id": 1, "type": "callassignment_target" }, "title": "First assignment" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "type": "null" }, "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "This is a call assignment called First assignment", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "example": "1857-07-05", "type": "string" }, "expose_target_details": { "example": 1, "type": "integer" }, "goal": { "$ref": "#/components/schemas/Target" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "Hello caller, Go ahead and call some people!", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "start_date": { "example": "1857-07-05", "type": "string" }, "target": { "properties": { "filter_spec": { "items": { "$ref": "#/components/schemas/Config#2" }, "type": "array" }, "id": { "example": 1, "type": "integer" }, "type": { "example": "callassignment_target", "type": "string" } }, "type": "object" }, "title": { "example": "First assignment", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment", "tags": ["Call"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-call_assignments-{assignment_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "campaign_id": 1, "disable_caller_notes": 1, "end_date": "1857-07-05", "start_date": "1857-07-05", "title": "New name example_string" }, "schema": { "properties": { "campaign_id": { "example": 1, "type": "integer" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "expose_target_details": { "example": 1, "type": "integer" }, "start_date": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "title": { "example": "New name example_string", "type": "string" }, "unknown_field": { "example": "foobar", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch call assignment", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-callers", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment caller", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers/{caller_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete call assignment caller", "tags": ["Call"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment caller", "tags": ["Call"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put call assignment caller", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers/{caller_id}/excluded_tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-excluded_tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment caller item excl tag", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers/{caller_id}/excluded_tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-excluded_tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete call assignment caller item excl tag", "tags": ["Call"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-excluded_tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put call assignment caller item excl tag", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers/{caller_id}/prioritized_tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-prioritized_tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment caller item prio tag", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/callers/{caller_id}/prioritized_tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-prioritized_tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete call assignment caller item prio tag", "tags": ["Call"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-call_assignments-{assignment_id}-callers-{caller_id}-prioritized_tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "caller_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put call assignment caller item prio tag", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/calls": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-calls", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment call", "tags": ["Call"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-call_assignments-{assignment_id}-calls", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "target_id": 1 }, "schema": { "properties": { "target_id": { "example": 1, "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post call assignment call", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/queue/head": { "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-call_assignments-{assignment_id}-queue-head", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post call assignment user queue head", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/queues": { "get": { "deprecated": false, "description": "This is really just a reflection of the callers that are assigned to\nthis CallAssignment, replacing those which have no individual config\n(excluded or prioritized tags) in favor of a default queue. The main\nreason for this endpoint is to provide links to the queue items.", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-queues", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment queue", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/queues/{queue_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-queues-{queue_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "default", "in": "path", "name": "queue_id", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment queue", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/stats": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment stats", "tags": ["Call"] } }, "/orgs/{org_id}/call_assignments/{assignment_id}/targets": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-call_assignments-{assignment_id}-targets", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assignment_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call assignment target", "tags": ["Call"] } }, "/orgs/{org_id}/calls": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-calls", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "allocation_time": "1857-07-05T00:00:00.000000+0000", "assignment_id": 1, "call_back_after": null, "caller": { "id": 1, "name": "Org 2 Organizer" }, "id": 1, "message_to_organizer": null, "notes": "These are some notes about the call", "organizer_action_needed": 1, "organizer_action_taken": 1, "state": 1, "target": { "alt_phone": null, "id": 1, "name": "Richard Elmqvist", "phone": "0724786483" }, "update_time": "1857-07-05T00:00:00.000000+0000" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "allocation_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "assignment_id": { "example": 1, "type": "integer" }, "call_back_after": { "type": "null" }, "caller": { "$ref": "#/components/schemas/Organization" }, "id": { "example": 1, "type": "integer" }, "message_to_organizer": { "type": "null" }, "notes": { "anyOf": [ { "type": "null" }, { "example": "These are some notes about the call", "type": "string" } ] }, "organizer_action_needed": { "example": 1, "type": "integer" }, "organizer_action_taken": { "anyOf": [ { "type": "null" }, { "example": 1, "type": "integer" } ] }, "state": { "example": 1, "type": "integer" }, "target": { "properties": { "alt_phone": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "name": { "example": "Karoline Westlund", "type": "string" }, "phone": { "example": "0733136083", "type": "string" } }, "type": "object" }, "update_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call", "tags": ["Call"] } }, "/orgs/{org_id}/calls/{call_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-calls-{call_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "call_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete call", "tags": ["Call"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-calls-{call_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "call_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get call", "tags": ["Call"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-calls-{call_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "call_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "notes": "Notes about the call", "state": 1 }, "schema": { "properties": { "invalid_attr": { "example": "value", "type": "string" }, "notes": { "example": "Notes about the call", "type": "string" }, "state": { "example": 1, "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch call", "tags": ["Call"] } }, "/orgs/{org_id}/campaigns": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "archived": 1, "cover_file": null, "id": 1, "info_text": null, "manager": null, "organization": { "id": 1, "title": "My Organization" }, "published": 1, "title": "Open campaign", "visibility": "open" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#9" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-campaigns", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "cover_file_id": 1, "manager_id": 1, "title": "Dummy campaign", "visibility": "open" }, "schema": { "properties": { "cover_file_id": { "example": 1, "type": "integer" }, "manager_id": { "example": 1, "type": "integer" }, "published": { "example": 1, "type": "integer" }, "title": { "example": "New campaign example_string", "type": "string" }, "visibility": { "example": "open", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "archived": 1, "cover_file": null, "id": 1, "info_text": "", "manager": { "id": 1, "name": "Rosa Luxemburg" }, "organization": { "id": 1, "title": "My Organization" }, "published": 1, "title": "New campaign example_string", "visibility": "open" } }, "schema": { "properties": { "data": { "properties": { "archived": { "example": 1, "type": "integer" }, "cover_file": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "manager": { "anyOf": [ { "properties": { "id": { "example": 1, "type": "integer" }, "name": { "example": "Rosa Luxemburg", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": 1, "type": "integer" }, "title": { "example": "New campaign example_string", "type": "string" }, "visibility": { "example": "open", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post campaign", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/stats/participation": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-stats-participation", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Tags" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign collection stats participation", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/stats/participation_by_hour": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-stats-participation_by_hour", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "count": 1, "hour": 1 } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Visits" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign collection stats participation by hour", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-campaigns-{campaign_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete campaign", "tags": ["Campaign"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": 1, "cover_file": null, "id": 1, "info_text": null, "manager": null, "organization": { "id": 1, "title": "My Other Organization" }, "published": 1, "title": "Open campaign", "visibility": "open" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#9" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign", "tags": ["Campaign"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-campaigns-{campaign_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "archived": 1 }, "schema": { "properties": { "archived": { "example": 1, "type": "integer" }, "cover_file_id": { "type": "null" }, "manager_id": { "type": "null" }, "published": { "example": 1, "type": "integer" }, "title": { "example": "New title example_string", "type": "string" }, "visibility": { "example": "open", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n1 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n1 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch campaign", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/actions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign action", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-campaigns-{campaign_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "400 Bad Request" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post campaign action", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/activities": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-activities", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign activity", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/call_assignments": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-call_assignments", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign call assignment", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-campaigns-{campaign_id}-call_assignments", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "cooldown": 1, "description": "My description", "disable_caller_notes": 1, "end_date": "1857-07-05", "goal_filters": [ { "config": { "operator": "notin", "query_id": 1 }, "op": "add", "type": "sub_query" } ], "instructions": "My instructions", "start_date": "1857-07-05", "target_filters": [ { "config": { "operator": "notin", "query_id": 1 }, "op": "add", "type": "sub_query" } ], "title": "New call assignment" }, "schema": { "properties": { "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "My description", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "example": "1857-07-05", "type": "string" }, "goal_filters": { "$ref": "#/components/schemas/FilterSpec#4" }, "instructions": { "example": "My instructions", "type": "string" }, "start_date": { "example": "1857-07-05", "type": "string" }, "target_filters": { "$ref": "#/components/schemas/FilterSpec#4" }, "title": { "example": "New call assignment", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "campaign": { "id": 1, "title": "Archived campaign" }, "cooldown": 1, "description": "My description", "disable_caller_notes": 1, "end_date": "1857-07-05", "expose_target_details": 1, "goal": { "filter_spec": [ { "config": { "operator": "notin", "query_id": 1 }, "op": "add", "type": "sub_query" } ], "id": 1, "type": "callassignment_goal" }, "id": 1, "instructions": "My instructions", "organization": { "id": 1, "title": "My Organization" }, "start_date": "1857-07-05", "target": { "filter_spec": [ { "config": { "operator": "notin", "query_id": 1 }, "op": "add", "type": "sub_query" } ], "id": 1, "type": "callassignment_target" }, "title": "New call assignment" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "$ref": "#/components/schemas/Organization" }, "cooldown": { "example": 1, "type": "integer" }, "description": { "example": "My description", "type": "string" }, "disable_caller_notes": { "example": 1, "type": "integer" }, "end_date": { "example": "1857-07-05", "type": "string" }, "expose_target_details": { "example": 1, "type": "integer" }, "goal": { "$ref": "#/components/schemas/Target#3" }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "My instructions", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "start_date": { "example": "1857-07-05", "type": "string" }, "target": { "$ref": "#/components/schemas/Target#3" }, "title": { "example": "New call assignment", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n2 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n2 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post campaign call assignment", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/cover": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-cover", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get campaign item cover", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/emails": { "get": { "deprecated": false, "description": "Retrieve a list of emails in this campaign", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-emails", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "content": "Test content", "subject": "Test subject", "title": "Test email" }, "schema": { "properties": { "content": { "example": "Test content", "type": "string" }, "subject": { "example": "Test subject", "type": "string" }, "title": { "example": "Test email", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign email", "tags": ["Email"] }, "post": { "deprecated": false, "description": "Create a new email in this campaign", "operationId": "post--orgs-{org_id}-campaigns-{campaign_id}-emails", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "content": "Test content", "subject": "Test subject", "title": "Test email" }, "schema": { "properties": { "content": { "example": "Test content", "type": "string" }, "subject": { "example": "Test subject", "type": "string" }, "title": { "example": "Test email", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "campaign": { "id": 1, "title": "First campaign in 4" }, "config": { "config": {}, "domain": "example.com", "id": 1, "no_reply": 1, "organization": { "id": 1, "title": "My Fourth Organization" }, "sender_email": "sender@example.com", "sender_name": "Example sender" }, "content": "Test content", "id": 1, "locked": null, "organization": { "id": 1, "title": "My Fourth Organization" }, "processed": null, "published": null, "reply_to": null, "subject": "Test subject", "target": { "filter_spec": [], "id": 1 }, "theme": null, "title": "Test email", "uuid": "123e4567-e89b-12d3-a456-426614174000" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "$ref": "#/components/schemas/Organization" }, "config": { "$ref": "#/components/schemas/Config#3" }, "content": { "example": "Test content", "type": "string" }, "id": { "example": 1, "type": "integer" }, "locked": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "processed": { "type": "null" }, "published": { "type": "null" }, "reply_to": { "type": "null" }, "subject": { "example": "Test subject", "type": "string" }, "target": { "$ref": "#/components/schemas/Target#4" }, "theme": { "type": "null" }, "title": { "example": "Test email", "type": "string" }, "uuid": { "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is invalid. Missing key: 'title'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post campaign email", "tags": ["Email"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/locations": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-locations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign location", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/stats/participation": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-stats-participation", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "count": 1, "date": "1857-07-05T00:00:00.000000+0000" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Tags" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign item stats participation", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/stats/participation_by_hour": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-stats-participation_by_hour", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign item stats participation by hour", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/surveys": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-surveys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "allow_anonymous": 1, "campaign": { "id": 1, "title": "Unpublihsed campaign" }, "expires": null, "id": 1, "info_text": "This is a survey", "org_access": "sameorg", "organization": { "id": 1, "title": "My Organization" }, "published": "1857-07-05T00:00:00.000000", "signature": "allow_anonymous", "title": "A very open survey" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "allow_anonymous": { "example": 1, "type": "integer" }, "campaign": { "$ref": "#/components/schemas/Organization" }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "This is a survey", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "A very open survey", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign survey", "tags": ["Campaign"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-campaigns-{campaign_id}-surveys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "access": "open", "callers_only": 1, "signature": "allow_anonymous", "title": "Test survey" }, "schema": { "properties": { "access": { "example": "open", "type": "string" }, "callers_only": { "example": 1, "type": "integer" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "Test survey", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "allow_anonymous": 1, "campaign": { "id": 1, "title": "Archived campaign" }, "expires": null, "id": 1, "info_text": "", "org_access": "sameorg", "organization": { "id": 1, "title": "My Organization" }, "published": null, "signature": "allow_anonymous", "title": "Test survey" } }, "schema": { "properties": { "data": { "properties": { "allow_anonymous": { "example": 1, "type": "integer" }, "campaign": { "$ref": "#/components/schemas/Organization" }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "type": "null" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "Test survey", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n2 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n2 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post campaign survey", "tags": ["Campaign"] } }, "/orgs/{org_id}/campaigns/{campaign_id}/tasks": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-campaigns-{campaign_id}-tasks", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "campaign": { "id": 1, "title": "Unpublihsed campaign" }, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "My Organization" }, "published": "1857-07-05T00:00:00.000000", "reassign_interval": null, "reassign_limit": null, "target": { "filter_spec": [ { "type": "all" } ], "id": 1 }, "time_estimate": null, "title": "Dummy task", "type": "offline" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#10" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get campaign task", "tags": ["Task"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-campaigns-{campaign_id}-tasks", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n2 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n2 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post campaign task", "tags": ["Task"] } }, "/orgs/{org_id}/email_themes": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-email_themes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "block_attributes": {}, "css": "", "frame_mjml": null, "id": 1 } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#13" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email theme", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-email_themes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "block_attributes": { "button": { "background-color": "#ED1C24", "border-radius": "2rem", "font-size": "1.3rem" } }, "css": "\n@font-face {\n font-family: franklin;\n src: url(https://zetkin.org/font.ttf);\n}\n\nbody {\n font-size: 16px;\n font-family: sans-serif;\n background-color: #ffffff;\n}\n\n.wrapper {\n background-color: #ffffff;\n}\n\nh1 {\n font-size: 2rem;\n}\n\nh2 {\n font-size: 1.6rem;\n}\n\nh3 {\n font-size: 1.3rem;\n}\n\np {\n font-size: 1.3rem;\n line-height: 1.4em;\n}\n\na {\n color: #000000;\n}\n\n.footer p {\n text-align: center;\n font-size: 1rem;\n}\n ", "frame_mjml": { "attributes": { "css-class": "wrapper" }, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "tagName": "placeholder" } ], "tagName": "mj-column" } ], "tagName": "mj-section" } ], "tagName": "mj-wrapper" } }, "schema": { "properties": { "block_attributes": { "$ref": "#/components/schemas/BlockAttributes" }, "css": { "example": "body { background-color: white; }", "type": "string" }, "frame_mjml": { "$ref": "#/components/schemas/FrameMjml" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "block_attributes": { "button": { "background-color": "red" } }, "css": "body { background-color: white; }", "frame_mjml": { "attributes": {}, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "tagName": "placeholder" } ], "tagName": "mj-column" } ], "tagName": "mj-section" } ], "tagName": "mj-wrapper" }, "id": 1 } }, "schema": { "properties": { "data": { "properties": { "block_attributes": { "anyOf": [ { "properties": { "button": { "properties": { "background-color": { "example": "red", "type": "string" }, "border-radius": { "example": "2rem", "type": "string" }, "font-size": { "example": "1.3rem", "type": "string" } }, "type": "object" } }, "type": "object" }, { "type": "null" } ] }, "css": { "anyOf": [ { "example": "body { background-color: white; }", "type": "string" }, { "type": "null" } ] }, "frame_mjml": { "anyOf": [ { "properties": { "attributes": { "properties": { "css-class": { "example": "wrapper", "type": "string" } }, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "tagName": { "example": "placeholder", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-column", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-section", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-wrapper", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "id": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'frame_mjml' error:\nOr(Or({'tagName': , 'attributes': }, {'tagName': , 'attributes': , 'content': }, {'tagName': , 'attributes': , 'children': [Or({'tagName': , 'attributes': }, {'tagName': , 'attributes': , 'content': }, {...})]}), None) did not validate {'tagName': 'mj-wrapper', 'attributes': {}, 'children': [{'foo': 'bar', 'attributes': {}}]}\nNone does not match {'tagName': 'mj-wrapper', 'attributes': {}, 'children': [{'foo': 'bar', 'attributes': {}}]}\" parameter is invalid. Key 'frame_mjml' error:\nOr(Or({'tagName': , 'attributes': }, {'tagName': , 'attributes': , 'content': }, {'tagName': , 'attributes': , 'children': [Or({'tagName': , 'attributes': }, {'tagName': , 'attributes': , 'content': }, {...})]}), None) did not validate {'tagName': 'mj-wrapper', 'attributes': {}, 'children': [{'foo': 'bar', 'attributes': {}}]}\nNone does not match {'tagName': 'mj-wrapper', 'attributes': {}, 'children': [{'foo': 'bar', 'attributes': {}}]}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post email theme", "tags": [] } }, "/orgs/{org_id}/email_themes/{theme_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-email_themes-{theme_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "theme_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete email theme", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-email_themes-{theme_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "theme_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "block_attributes": {}, "css": "", "frame_mjml": null, "id": 1 } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#13" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email theme", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-email_themes-{theme_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "theme_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "block_attributes": { "button": { "background-color": "#ED1C24", "border-radius": "2rem", "font-size": "1.3rem" } }, "css": "\n@font-face {\n font-family: franklin;\n src: url(https://zetkin.org/font.ttf);\n}\n\nbody {\n font-size: 16px;\n font-family: sans-serif;\n background-color: #ffffff;\n}\n\n.wrapper {\n background-color: #ffffff;\n}\n\nh1 {\n font-size: 2rem;\n}\n\nh2 {\n font-size: 1.6rem;\n}\n\nh3 {\n font-size: 1.3rem;\n}\n\np {\n font-size: 1.3rem;\n line-height: 1.4em;\n}\n\na {\n color: #000000;\n}\n\n.footer p {\n text-align: center;\n font-size: 1rem;\n}\n ", "frame_mjml": { "attributes": { "css-class": "wrapper" }, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "tagName": "placeholder" } ], "tagName": "mj-column" } ], "tagName": "mj-section" } ], "tagName": "mj-wrapper" } }, "schema": { "properties": { "block_attributes": { "$ref": "#/components/schemas/BlockAttributes" }, "css": { "example": "body { background-color: red; }", "type": "string" }, "frame_mjml": { "$ref": "#/components/schemas/FrameMjml" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "block_attributes": { "button": { "background-color": "#ED1C24", "border-radius": "2rem", "font-size": "1.3rem" } }, "css": "\n@font-face {\n font-family: franklin;\n src: url(https://zetkin.org/font.ttf);\n}\n\nbody {\n font-size: 16px;\n font-family: sans-serif;\n background-color: #ffffff;\n}\n\n.wrapper {\n background-color: #ffffff;\n}\n\nh1 {\n font-size: 2rem;\n}\n\nh2 {\n font-size: 1.6rem;\n}\n\nh3 {\n font-size: 1.3rem;\n}\n\np {\n font-size: 1.3rem;\n line-height: 1.4em;\n}\n\na {\n color: #000000;\n}\n\n.footer p {\n text-align: center;\n font-size: 1rem;\n}\n ", "frame_mjml": { "attributes": { "css-class": "wrapper" }, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "children": [ { "attributes": {}, "tagName": "placeholder" } ], "tagName": "mj-column" } ], "tagName": "mj-section" } ], "tagName": "mj-wrapper" }, "id": 1 } }, "schema": { "properties": { "data": { "properties": { "block_attributes": { "anyOf": [ { "type": "null" }, { "properties": { "button": { "properties": { "background-color": { "example": "#ED1C24", "type": "string" }, "border-radius": { "example": "2rem", "type": "string" }, "font-size": { "example": "1.3rem", "type": "string" } }, "type": "object" } }, "type": "object" } ] }, "css": { "example": "body { background-color: red; }", "type": "string" }, "frame_mjml": { "anyOf": [ { "type": "null" }, { "properties": { "attributes": { "properties": { "css-class": { "example": "wrapper", "type": "string" } }, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "children": { "items": { "properties": { "attributes": { "properties": {}, "type": "object" }, "tagName": { "example": "placeholder", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-column", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-section", "type": "string" } }, "type": "object" }, "type": "array" }, "tagName": { "example": "mj-wrapper", "type": "string" } }, "type": "object" } ] }, "id": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"unknown\" parameter is invalid. Wrong key 'unknown' in {'unknown': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch email theme", "tags": [] } }, "/orgs/{org_id}/emails": { "get": { "deprecated": false, "description": "Retrieve a list of emails in this organization", "operationId": "get--orgs-{org_id}-emails", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "campaign": { "id": 1, "title": "First campaign in 1" }, "config": null, "content": null, "id": 1, "locked": null, "organization": { "id": 1, "title": "My Organization" }, "processed": null, "published": "1857-07-05T00:00:00.000000+0000", "reply_to": null, "subject": "Test subject", "target": null, "theme": null, "title": "Test email", "uuid": "123e4567-e89b-12d3-a456-426614174000" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "campaign": { "$ref": "#/components/schemas/Organization" }, "config": { "type": "null" }, "content": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "locked": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "processed": { "type": "null" }, "published": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "reply_to": { "type": "null" }, "subject": { "example": "Test subject", "type": "string" }, "target": { "type": "null" }, "theme": { "type": "null" }, "title": { "example": "Test email", "type": "string" }, "uuid": { "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email", "tags": ["Email"] }, "post": { "deprecated": false, "description": "Create a new email in this organization", "operationId": "post--orgs-{org_id}-emails", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "campaign_id": 1, "content": "Test content", "subject": "Test subject", "title": "Test email" }, "schema": { "properties": { "campaign_id": { "example": 1, "type": "integer" }, "content": { "example": "Test content", "type": "string" }, "subject": { "example": "Test subject", "type": "string" }, "theme_id": { "example": 1, "type": "integer" }, "title": { "example": "Test email", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is invalid. Missing key: 'title'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post email", "tags": ["Email"] } }, "/orgs/{org_id}/emails/configs": { "get": { "deprecated": false, "description": "Retrieve a list of email configs in this organization", "operationId": "get--orgs-{org_id}-emails-configs", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "config": {}, "domain": "example.com", "id": 1, "no_reply": 1, "organization": { "id": 1, "title": "My Organization" }, "sender_email": "sender@example.com", "sender_name": "Example sender" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Config#3" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get email config", "tags": ["Email"] }, "post": { "deprecated": false, "description": "Create an email config in this organization", "operationId": "post--orgs-{org_id}-emails-configs", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "config": { "mock_key": "test" }, "domain": "example.com", "no_reply": 1, "sender_email": "mock@example.org", "sender_name": "Mock organization" }, "schema": { "properties": { "config": { "$ref": "#/components/schemas/Error" }, "domain": { "example": "example.com", "type": "string" }, "no_reply": { "example": 1, "type": "integer" }, "sender_email": { "example": "mock@example.org", "type": "string" }, "sender_name": { "example": "Mock organization", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "config": { "mock_key": "test" }, "domain": "example.com", "id": 1, "no_reply": 1, "organization": { "id": 1, "title": "My Organization" }, "sender_email": "mock@example.org", "sender_name": "Mock organization" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#12" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"config\" parameter is invalid. Missing keys: 'config', 'domain', 'sender_email', 'sender_name'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post email config", "tags": ["Email"] } }, "/orgs/{org_id}/emails/configs/{config_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-emails-configs-{config_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "config_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "config": {}, "domain": "example.com", "id": 1, "no_reply": 1, "organization": { "id": 1, "title": "My Organization" }, "sender_email": "test@example.com", "sender_name": "Test organization" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Config#3" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get email config", "tags": ["Email"] }, "patch": { "deprecated": false, "description": "Update a specific email config in this organization", "operationId": "patch--orgs-{org_id}-emails-configs-{config_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "config_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "config": { "dummyKey": "dummyValue" }, "domain": "example.com", "sender_email": "test@example.com", "sender_name": "Dummy Organization" }, "schema": { "properties": { "config": { "$ref": "#/components/schemas/Error" }, "domain": { "example": "example.com", "type": "string" }, "sender_email": { "example": "test@example.com", "type": "string" }, "sender_name": { "example": "Dummy Organization", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "config": { "dummyKey": "dummyValue" }, "domain": "example.com", "id": 1, "no_reply": 1, "organization": { "id": 1, "title": "My Organization" }, "sender_email": "test@example.com", "sender_name": "Dummy Organization" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#12" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"sender_email\" parameter is invalid. sender_email is not an email address", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Patch email config", "tags": ["Email"] } }, "/orgs/{org_id}/emails/{email_id}": { "delete": { "deprecated": false, "description": "Delete a specific email in this organization", "operationId": "delete--orgs-{org_id}-emails-{email_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "subject": "Updated subject", "title": "New title" }, "schema": { "properties": { "subject": { "example": "Updated subject", "type": "string" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Delete email", "tags": ["Email"] }, "get": { "deprecated": false, "description": "Retrieve a specific email in this organization", "operationId": "get--orgs-{org_id}-emails-{email_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "campaign": null, "config": null, "content": null, "id": 1, "locked": "1857-07-05T00:00:00.000000+0000", "organization": { "id": 1, "title": "My Organization" }, "processed": null, "published": null, "reply_to": null, "subject": null, "target": null, "theme": null, "title": "Test email", "uuid": "123e4567-e89b-12d3-a456-426614174000" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "type": "null" }, "config": { "type": "null" }, "content": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "locked": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } ] }, "organization": { "$ref": "#/components/schemas/Organization" }, "processed": { "type": "null" }, "published": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } ] }, "reply_to": { "type": "null" }, "subject": { "type": "null" }, "target": { "type": "null" }, "theme": { "type": "null" }, "title": { "example": "Test email", "type": "string" }, "uuid": { "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email", "tags": ["Email"] }, "patch": { "deprecated": false, "description": "Update a specific email in this organization", "operationId": "patch--orgs-{org_id}-emails-{email_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "subject": "Updated subject", "theme_id": 1, "title": "New title" }, "schema": { "properties": { "campaign_id": { "example": 1, "type": "integer" }, "content": { "example": "New content", "type": "string" }, "locked": { "example": 1, "type": "integer" }, "published": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "subject": { "example": "Updated subject", "type": "string" }, "theme_id": { "example": 1, "type": "integer" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "campaign": null, "config": null, "content": null, "id": 1, "locked": null, "organization": { "id": 1, "title": "My Organization" }, "processed": null, "published": null, "reply_to": null, "subject": "Updated subject", "target": null, "theme": { "block_attributes": null, "css": null, "frame_mjml": null, "id": 1 }, "title": "New title", "uuid": "123e4567-e89b-12d3-a456-426614174000" } }, "schema": { "properties": { "data": { "properties": { "campaign": { "type": "null" }, "config": { "type": "null" }, "content": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "locked": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } ] }, "organization": { "$ref": "#/components/schemas/Organization" }, "processed": { "type": "null" }, "published": { "type": "null" }, "reply_to": { "type": "null" }, "subject": { "anyOf": [ { "example": "Updated subject", "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "null" }, { "properties": { "filter_spec": { "items": { "properties": { "config": { "properties": { "fields": { "properties": { "first_name": { "example": "Rosa", "type": "string" }, "last_name": { "example": "Luxemburg", "type": "string" } }, "type": "object" } }, "type": "object" }, "op": { "example": "add", "type": "string" }, "type": { "example": "person_data", "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "example": 1, "type": "integer" } }, "type": "object" } ] }, "theme": { "anyOf": [ { "type": "null" }, { "properties": { "block_attributes": { "type": "null" }, "css": { "type": "null" }, "frame_mjml": { "type": "null" }, "id": { "example": 1, "type": "integer" } }, "type": "object" } ] }, "title": { "example": "New title", "type": "string" }, "uuid": { "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid_key\" parameter is invalid. Wrong key 'invalid_key' in {'invalid_key': 'invalid_value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Cannot lock or unlock a scheduled email" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Patch email", "tags": ["Email"] } }, "/orgs/{org_id}/emails/{email_id}/links": { "get": { "deprecated": false, "description": "Get the target query for this email", "operationId": "get--orgs-{org_id}-emails-{email_id}-links", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "email": { "id": 1, "title": "Test email" }, "id": 1, "tag": "dummyTag", "url": "https://example.com" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email link", "tags": ["Email"] } }, "/orgs/{org_id}/emails/{email_id}/preview": { "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-emails-{email_id}-preview", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "recipients": [ { "email": "clara@zetkin.org", "first_name": "Clara", "last_name": "Zetkin" } ] }, "schema": { "properties": { "recipients": { "items": { "$ref": "#/components/schemas/AssignedRoute" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post email preview", "tags": [] } }, "/orgs/{org_id}/emails/{email_id}/recipients": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-emails-{email_id}-recipients", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "properties": { "delivered": { "type": "null" }, "email": { "$ref": "#/components/schemas/Organization" }, "email_address": { "type": "null" }, "error": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "opened": { "type": "null" }, "person": { "$ref": "#/components/schemas/Config" }, "sent": { "type": "null" }, "status": { "example": "pending", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get email recipient", "tags": [] } }, "/orgs/{org_id}/emails/{email_id}/stats": { "get": { "deprecated": false, "description": "Get the stats for this email", "operationId": "get--orgs-{org_id}-emails-{email_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "email_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "num_blocked": { "any": 1, "blacklisted": 1, "no_email": 1, "unsubscribed": 1 }, "num_clicks": 1, "num_clicks_by_link": { "9": 1 }, "num_locked_targets": 1, "num_opened": 1, "num_sent": 1, "num_target_matches": 1 } }, "schema": { "properties": { "data": { "properties": { "num_blocked": { "$ref": "#/components/schemas/NumBlocked" }, "num_clicks": { "example": 1, "type": "integer" }, "num_clicks_by_link": { "$ref": "#/components/schemas/NumBlocked" }, "num_locked_targets": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] }, "num_opened": { "example": 1, "type": "integer" }, "num_sent": { "example": 1, "type": "integer" }, "num_target_matches": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get email stats", "tags": ["Email"] } }, "/orgs/{org_id}/files": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-files", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "mime_type": "application/pdf", "organization": { "id": 1, "title": "My Organization" }, "original_name": "dummy.pdf", "uploaded": "1857-07-05T00:00:00.000000", "url": "http://files.dev.zetkin.org/1/dummy.pdf" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "mime_type": { "example": "application/pdf", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "original_name": { "example": "dummy.pdf", "type": "string" }, "uploaded": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "url": { "example": "http://files.dev.zetkin.org/1/dummy.pdf", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get file", "tags": ["Files"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-files", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "No file provided" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post file", "tags": ["Files"] } }, "/orgs/{org_id}/files{file_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-files{file_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "file_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Delete file", "tags": ["Files"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-files{file_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "file_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": 1, "mime_type": null, "organization": { "id": 1, "title": "My Organization" }, "original_name": "test.jpg", "uploaded": "1857-07-05T00:00:00.000000", "url": "http://files.dev.zetkin.org/1/storetest.jpg" } }, "schema": { "properties": { "data": { "properties": { "id": { "example": 1, "type": "integer" }, "mime_type": { "type": "null" }, "organization": { "$ref": "#/components/schemas/Organization" }, "original_name": { "example": "test.jpg", "type": "string" }, "uploaded": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "url": { "example": "http://files.dev.zetkin.org/1/storetest.jpg", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get file", "tags": ["Files"] } }, "/orgs/{org_id}/household_visits": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-household_visits", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "address": { "address": "Other street 2", "id": "abc123" }, "allocation_time": "1857-07-05T00:00:00.000000", "assigned_route": { "assignment_id": "abc123", "id": "abc123", "route_id": "abc123" }, "household_id": "mHHAP", "id": "mLHAP", "state": 1, "visit_time": null, "visitor": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#8" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get household visit", "tags": ["Canvass"] } }, "/orgs/{org_id}/household_visits/{visit_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-household_visits-{visit_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "visit_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "address": { "address": "Other street 2", "id": "abc123" }, "allocation_time": "1857-07-05T00:00:00.000000", "assigned_route": { "assignment_id": "abc123", "id": "abc123", "route_id": "abc123" }, "household_id": "abc123", "id": "abc123", "state": 1, "visit_time": "1857-07-05T00:00:00.000000", "visitor": { "id": 1, "name": "Angela Davis" } } }, "schema": { "properties": { "data": { "properties": { "address": { "$ref": "#/components/schemas/Error#2" }, "allocation_time": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assigned_route": { "$ref": "#/components/schemas/AssignedRoute" }, "household_id": { "example": "abc123", "type": "string" }, "id": { "example": "abc123", "type": "string" }, "state": { "example": 1, "type": "integer" }, "visit_time": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "visitor": { "$ref": "#/components/schemas/Organization" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get household visit", "tags": ["Canvass"] } }, "/orgs/{org_id}/households": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-households", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "address": { "id": "mGHAP", "street": "Av 1" }, "id": "abc123", "label": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#5" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get household", "tags": ["Canvass"] } }, "/orgs/{org_id}/households/{household_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-households-{household_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "household_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete household", "tags": ["Canvass"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-households-{household_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "household_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "label": "New label" }, "schema": { "properties": { "label": { "example": "New label", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get household", "tags": ["Canvass"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-households-{household_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "household_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "label": "New label" }, "schema": { "properties": { "label": { "example": "New label", "type": "string" }, "unknown_field": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch household", "tags": ["Canvass"] } }, "/orgs/{org_id}/invites": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-invites", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "invite_email": "abc123", "invite_time": "1857-07-05T00:00:00.000000+0000", "is_consumed": 1, "official": { "id": 1, "name": "Rosa Luxemburg" }, "organization": { "id": 1, "title": "My Organization" } } ] }, "schema": { "properties": { "data": { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "invite_email": { "example": "abc123", "type": "string" }, "invite_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "is_consumed": { "example": 1, "type": "integer" }, "official": { "$ref": "#/components/schemas/Organization" }, "organization": { "$ref": "#/components/schemas/Organization" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get invite", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-invites", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "email": "testuser@example.com" }, "schema": { "properties": { "email": { "example": "abc123", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "invite_email": "abc123", "invite_time": "1857-07-05T00:00:00.000000+0000", "is_consumed": 1, "official": { "id": 1, "name": "Angela Davis" }, "organization": { "id": 1, "title": "My Organization" } } }, "schema": { "properties": { "data": { "properties": { "id": { "example": 1, "type": "integer" }, "invite_email": { "example": "abc123", "type": "string" }, "invite_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "is_consumed": { "example": 1, "type": "integer" }, "official": { "anyOf": [ { "properties": { "id": { "example": 1, "type": "integer" }, "name": { "example": "Angela Davis", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "organization": { "$ref": "#/components/schemas/Organization" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "400 Bad Request" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "An invite has already been sent to this address", "title": "Invite exists" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post invite", "tags": ["Organizations"] } }, "/orgs/{org_id}/invites/{invite_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-invites-{invite_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "invite_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete invite", "tags": ["Organizations"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-invites-{invite_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "invite_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get invite", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_forms": { "get": { "deprecated": false, "description": "Get list of join forms. Each join form is it's own configuration of accepted\nfields and tags that will be assigned when a submission is accepted.", "operationId": "get--orgs-{org_id}-join_forms", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "description": null, "embeddable": 1, "fields": ["first_name"], "id": 1, "org_access": "sameorg", "organization": { "id": 1, "title": "My Organization" }, "renderable": 1, "requires_email_verification": 1, "submit_token": "abc123", "tags": [ { "id": 1, "title": "Activist" } ], "title": "Dummy join form" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "description": { "type": "null" }, "embeddable": { "example": 1, "type": "integer" }, "fields": { "$ref": "#/components/schemas/AllowedGrants" }, "id": { "example": 1, "type": "integer" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "renderable": { "example": 1, "type": "integer" }, "requires_email_verification": { "example": 1, "type": "integer" }, "submit_token": { "example": "abc123", "type": "string" }, "tags": { "$ref": "#/components/schemas/Tags" }, "title": { "example": "Dummy join form", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get join form", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-join_forms", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "My description", "embeddable": 1, "fields": ["first_name"], "org_access": "sameorg", "renderable": 1, "requires_email_verification": 1, "tags": [1], "title": "Posted from" }, "schema": { "properties": { "description": { "example": "My description", "type": "string" }, "embeddable": { "example": 1, "type": "integer" }, "fields": { "$ref": "#/components/schemas/AllowedGrants" }, "org_access": { "example": "sameorg", "type": "string" }, "renderable": { "example": 1, "type": "integer" }, "requires_email_verification": { "example": 1, "type": "integer" }, "tags": { "$ref": "#/components/schemas/Organizations" }, "title": { "example": "Posted from", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "description": "My description", "embeddable": 1, "fields": ["first_name"], "id": 1, "org_access": "sameorg", "organization": { "id": 1, "title": "My Organization" }, "renderable": 1, "requires_email_verification": 1, "submit_token": "example_string", "tags": [ { "id": 1, "title": "Activist" } ], "title": "Posted from" } }, "schema": { "properties": { "data": { "properties": { "description": { "example": "My description", "type": "string" }, "embeddable": { "example": 1, "type": "integer" }, "fields": { "$ref": "#/components/schemas/AllowedGrants" }, "id": { "example": 1, "type": "integer" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "renderable": { "example": 1, "type": "integer" }, "requires_email_verification": { "example": 1, "type": "integer" }, "submit_token": { "example": "example_string", "type": "string" }, "tags": { "$ref": "#/components/schemas/Tags" }, "title": { "example": "Posted from", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"unknown_field\" parameter is invalid. Wrong key 'unknown_field' in {'title': 'Posted from', 'description': 'My description', 'renderable': True, 'embeddable': True, 'org_access': 'sameorg', 'requires_email_verification': False, 'fields': ['first_name', 'last_name', 'extra_data'], 'tags': [1], 'unknown_field': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post join form", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_forms/{form_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-join_forms-{form_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete join form", "tags": ["Organizations"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-join_forms-{form_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get join form", "tags": ["Organizations"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-join_forms-{form_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "org_access": "suborgs", "requires_email_verification": 1, "title": "New title" }, "schema": { "properties": { "fields": { "$ref": "#/components/schemas/AllowedGrants" }, "org_access": { "example": "suborgs", "type": "string" }, "requires_email_verification": { "example": 1, "type": "integer" }, "submit_token": { "type": "null" }, "tags": { "$ref": "#/components/schemas/Organizations" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Incorrectly formatted data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch join form", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_forms/{form_id}/submissions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-join_forms-{form_id}-submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get join form submission", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "Submit a join form and create a submission which will then need to be accepted\nby an official using `PATCH` on the submission item.\n\nThe data must contain the `submit_token` of the form, and a `form_data` object\ncontaining the fields that the form has been configured to accept.\n\n```json\n{\n \"submit_token\": \"abc123def456\",\n \"form_data\": {\n \"first_name\": \"Clara\",\n \"last_name\": \"Zetkin\",\n }\n}\n```", "operationId": "post--orgs-{org_id}-join_forms-{form_id}-submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "form_data": { "email": "clara@example.com", "first_name": "Clara", "last_name": "Joinee" }, "submit_token": "abc123" }, "schema": { "properties": { "form_data": { "properties": { "email": { "example": "clara@example.com", "type": "string" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "first_name": { "example": "Clara", "type": "string" }, "last_name": { "example": "Joinee", "type": "string" }, "phone": { "example": "+46701234567", "type": "string" }, "unknown_field": { "example": "value", "type": "string" } }, "type": "object" }, "submit_token": { "example": "abc123", "type": "string" }, "unknown_attr": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "accepted": null, "form": { "id": 1, "title": "Ancestor Join Form" }, "id": 1, "person_data": { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": null, "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "last_name": "Zetkin", "phone": null, "street_address": null, "zip_code": null }, "state": "pending", "submitted": "1857-07-05T00:00:00.000000" } }, "schema": { "properties": { "data": { "properties": { "accepted": { "type": "null" }, "form": { "$ref": "#/components/schemas/Organization" }, "id": { "example": 1, "type": "integer" }, "person_data": { "$ref": "#/components/schemas/PersonData" }, "state": { "example": "pending", "type": "string" }, "submitted": { "example": "1857-07-05T00:00:00.000000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 202" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post join form submission", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_requests": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-join_requests", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "accept_time": null, "accepting_official": null, "id": 1, "is_accepted": 1, "organization": { "id": 1, "title": "My Organization" }, "request_time": "1857-07-05T00:00:00.000000+0000", "user_id": 1 } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#14" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get join request", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-join_requests", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "user_id": 1 }, "schema": { "properties": { "user_id": { "example": 1, "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "accept_time": null, "accepting_official": null, "id": 1, "is_accepted": 1, "organization": { "id": 1, "title": "Dummy org example_string" }, "request_time": "1857-07-05T00:00:00.000000+0000", "user_id": 1 } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#14" } }, "type": "object" } } }, "description": "Example response for status 202" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"user_id\" parameter is invalid. User does not exist", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "409 Conflict" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post join request", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_submissions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-join_submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "form_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "accepted": null, "form": { "id": 1, "title": "Dummy form" }, "id": 1, "person_data": { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": "clara@example.com", "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "last_name": "Zetkin", "phone": null, "street_address": null, "zip_code": null }, "state": "pending", "submitted": "1857-07-05T00:00:00.000000" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "accepted": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "form": { "$ref": "#/components/schemas/Organization" }, "id": { "example": 1, "type": "integer" }, "person_data": { "$ref": "#/components/schemas/PersonData" }, "state": { "example": "pending", "type": "string" }, "submitted": { "example": "1857-07-05T00:00:00.000000", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get join submission", "tags": ["Organizations"] } }, "/orgs/{org_id}/join_submissions/{sub_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-join_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete join submission", "tags": ["Organizations"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-join_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get join submission", "tags": ["Organizations"] }, "patch": { "deprecated": false, "description": "Allows the `state` of a submission to be changed from `\"pending\"` to `\"accepted\"`,\nwhich will create a person in the organization from the submitted data, and assign\nthe tags configured on the join form.", "operationId": "patch--orgs-{org_id}-join_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "state": "accepted" }, "schema": { "properties": { "state": { "example": "accepted", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "accepted": "1857-07-05T00:00:00.000000", "form": { "id": 1, "title": "Dummy join form" }, "id": 1, "person_data": { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": null, "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "last_name": "Deleted", "phone": null, "street_address": null, "zip_code": null }, "state": "accepted", "submitted": "1857-07-05T00:00:00.000000" } }, "schema": { "properties": { "data": { "properties": { "accepted": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "form": { "$ref": "#/components/schemas/Organization" }, "id": { "example": 1, "type": "integer" }, "person_data": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "type": "null" }, "ext_id": { "type": "null" }, "first_name": { "example": "Clara", "type": "string" }, "gender": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "type": "null" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "state": { "example": "accepted", "type": "string" }, "submitted": { "example": "1857-07-05T00:00:00.000000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Incorrectly formatted data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch join submission", "tags": ["Organizations"] } }, "/orgs/{org_id}/journey_instances": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assignees": [], "closed": null, "created": "1857-07-05T00:00:00.000000", "id": 1, "journey": { "id": 1, "plural_label": "Cases", "singular_label": "Case", "title": "Case" }, "next_milestone": { "completed": null, "deadline": null, "description": "", "id": 1, "title": "Evidence collected" }, "opening_note": "", "organization": { "id": 1, "title": "example_string" }, "outcome": "", "subjects": [], "summary": "", "tags": [], "title": "Case Two", "updated": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "assignees": { "$ref": "#/components/schemas/Subjects" }, "closed": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/User" }, "next_milestone": { "$ref": "#/components/schemas/NextMilestone" }, "opening_note": { "example": "", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "outcome": { "example": "", "type": "string" }, "subjects": { "$ref": "#/components/schemas/Subjects" }, "summary": { "example": "", "type": "string" }, "tags": { "$ref": "#/components/schemas/Tags#2" }, "title": { "example": "Case One", "type": "string" }, "updated": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey instance", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journey_instances-{instance_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "outcome": "It went well", "summary": "This is a case", "title": "New title" }, "schema": { "properties": { "outcome": { "example": "It went well", "type": "string" }, "summary": { "example": "This is a case", "type": "string" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey instance", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances-{instance_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey instance", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-journey_instances-{instance_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "journey_id": 1 }, "schema": { "properties": { "journey_id": { "example": 1, "type": "integer" }, "outcome": { "example": "It went well", "type": "string" }, "summary": { "example": "This is a case", "type": "string" }, "title": { "anyOf": [ { "example": "New title", "type": "string" }, { "example": 1, "type": "integer" } ] }, "unknown": { "example": "attr", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "assignees": [], "closed": null, "created": "1857-07-05T00:00:00.000000", "id": 1, "journey": { "id": 1, "plural_label": "Other journeys", "singular_label": "Other journey", "title": "Other journey" }, "milestones": [ { "completed": "1857-07-05T00:00:00.000000", "deadline": null, "description": "", "id": 1, "title": "Evidence collected" } ], "next_milestone": { "completed": null, "deadline": null, "description": "", "id": 1, "title": "Dummy milestone" }, "opening_note": "", "organization": { "id": 1, "title": "My Organization" }, "outcome": "", "subjects": [], "summary": "", "tags": [], "title": null, "updated": "1857-07-05T00:00:00.000000" } }, "schema": { "properties": { "data": { "properties": { "assignees": { "$ref": "#/components/schemas/FilterSpec" }, "closed": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/User" }, "milestones": { "items": { "$ref": "#/components/schemas/Data#16" }, "type": "array" }, "next_milestone": { "$ref": "#/components/schemas/NextMilestone" }, "opening_note": { "example": "", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "outcome": { "example": "", "type": "string" }, "subjects": { "$ref": "#/components/schemas/FilterSpec" }, "summary": { "example": "", "type": "string" }, "tags": { "$ref": "#/components/schemas/FilterSpec" }, "title": { "type": "null" }, "updated": { "example": "1857-07-05T00:00:00.000000", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch journey instance", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/assignees/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journey_instances-{instance_id}-assignees-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey instance assignee", "tags": [] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-journey_instances-{instance_id}-assignees-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "title": "409 Conflict" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Put journey instance assignee", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/milestones": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances-{instance_id}-milestones", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey instance milestone", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/milestones/{milestone_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances-{instance_id}-milestones-{milestone_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "completed": "1857-07-05T00:00:00.000000", "deadline": null, "description": "", "id": 1, "title": "Evidence collected" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#16" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey instance milestone", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-journey_instances-{instance_id}-milestones-{milestone_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "completed": null }, "schema": { "properties": { "completed": { "anyOf": [ { "type": "null" }, { "example": 1, "type": "integer" } ] }, "unknown": { "example": "attr", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "completed": null, "deadline": null, "description": "", "id": 1, "title": "Evidence collected" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/NextMilestone" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch journey instance milestone", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/notes": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances-{instance_id}-notes", "summary": "Get journey instance note", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-journey_instances-{instance_id}-notes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "This is my note" }, "schema": { "properties": { "file_ids": { "$ref": "#/components/schemas/Organizations" }, "text": { "example": "This is my note", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "author": { "id": 1, "name": "Angela Davis" }, "created": "1857-07-05T00:00:00.000000", "files": [], "id": 1, "organization": { "id": 1, "title": "My Organization" }, "text": "This is my note" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#17" } }, "type": "object" } } }, "description": "Example response for status 201" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post journey instance note", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/notes/{note_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journey_instances-{instance_id}-notes-{note_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "note_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey instance note", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-journey_instances-{instance_id}-notes-{note_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "note_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "This is my updated note" }, "schema": { "properties": { "text": { "example": "This is my updated note", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "author": { "id": 1, "name": "Angela Davis" }, "created": "1857-07-05T00:00:00.000000", "files": [], "id": 1, "organization": { "id": 1, "title": "My Organization" }, "text": "This is my updated note" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#17" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch journey instance note", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/subjects/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journey_instances-{instance_id}-subjects-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey instance subject", "tags": [] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-journey_instances-{instance_id}-subjects-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "title": "409 Conflict" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Put journey instance subject", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journey_instances-{instance_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey instance tag", "tags": [] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-journey_instances-{instance_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "value": "test" }, "schema": { "properties": { "value": { "example": "test", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "color": null, "description": "", "group": null, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "My Organization" }, "title": "Value tag", "value": "test", "value_type": "text" } }, "schema": { "properties": { "data": { "properties": { "color": { "type": "null" }, "description": { "example": "", "type": "string" }, "group": { "type": "null" }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Value tag", "type": "string" }, "value": { "example": "test", "type": "string" }, "value_type": { "example": "text", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "title": "409 Conflict" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Put journey instance tag", "tags": [] } }, "/orgs/{org_id}/journey_instances/{instance_id}/timeline/updates": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journey_instances-{instance_id}-timeline-updates", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "instance_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey instance timeline update", "tags": [] } }, "/orgs/{org_id}/journeys": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journeys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "description": "", "id": 1, "opening_note_template": "", "organization": { "id": 1, "title": "My Organization" }, "plural_label": "Cases", "singular_label": "Case", "stats": { "closed": 1, "open": 1 }, "title": "Case" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#15" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-journeys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "This is a legal case", "opening_note_template": "Provide som info about the case", "plural_label": "cases", "singular_label": "case", "title": "Case" }, "schema": { "properties": { "description": { "example": "This is a legal case", "type": "string" }, "opening_note_template": { "example": "Provide som info about the case", "type": "string" }, "plural_label": { "example": "cases", "type": "string" }, "singular_label": { "example": "case", "type": "string" }, "title": { "example": "Case", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "description": "This is a legal case", "id": 1, "opening_note_template": "Provide som info about the case", "organization": { "id": 1, "title": "My Organization" }, "plural_label": "cases", "singular_label": "case", "stats": { "closed": 1, "open": 1 }, "title": "Case" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#15" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n1 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n1 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post journey", "tags": [] } }, "/orgs/{org_id}/journeys/{journey_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journeys-{journey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journeys-{journey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-journeys-{journey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "Legal Case" }, "schema": { "properties": { "title": { "example": "Legal Case", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n1 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n1 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch journey", "tags": [] } }, "/orgs/{org_id}/journeys/{journey_id}/instances": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journeys-{journey_id}-instances", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assignees": [], "closed": null, "created": "1857-07-05T00:00:00.000000", "id": 1, "journey": { "id": 1, "plural_label": "dummies", "singular_label": "dummy", "title": "Dummy journey" }, "next_milestone": null, "opening_note": "", "organization": { "id": 1, "title": "My Organization" }, "outcome": "", "subjects": [], "summary": "", "tags": [], "title": null, "updated": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "assignees": { "$ref": "#/components/schemas/FilterSpec" }, "closed": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/User" }, "next_milestone": { "type": "null" }, "opening_note": { "example": "", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "outcome": { "example": "", "type": "string" }, "subjects": { "$ref": "#/components/schemas/FilterSpec" }, "summary": { "example": "", "type": "string" }, "tags": { "$ref": "#/components/schemas/FilterSpec" }, "title": { "type": "null" }, "updated": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey journey instance", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-journeys-{journey_id}-instances", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "opening_note": "ths is a new case", "summary": "A summary", "title": "New case" }, "schema": { "properties": { "opening_note": { "example": "ths is a new case", "type": "string" }, "summary": { "example": "A summary", "type": "string" }, "title": { "anyOf": [ { "example": "New case", "type": "string" }, { "example": 1, "type": "integer" } ] }, "unknown": { "example": "attr", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "assignees": [], "closed": null, "created": "1857-07-05T00:00:00.000000", "id": 1, "journey": { "id": 1, "plural_label": "cases", "singular_label": "case", "title": "Case in org A" }, "next_milestone": null, "opening_note": "ths is a new case", "organization": { "id": 1, "title": "Org A" }, "outcome": "", "subjects": [], "summary": "A summary", "tags": [], "title": "New case", "updated": null } }, "schema": { "properties": { "data": { "properties": { "assignees": { "$ref": "#/components/schemas/FilterSpec" }, "closed": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/User" }, "next_milestone": { "type": "null" }, "opening_note": { "example": "ths is a new case", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "outcome": { "example": "", "type": "string" }, "subjects": { "$ref": "#/components/schemas/FilterSpec" }, "summary": { "example": "A summary", "type": "string" }, "tags": { "$ref": "#/components/schemas/FilterSpec" }, "title": { "example": "New case", "type": "string" }, "updated": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post journey journey instance", "tags": [] } }, "/orgs/{org_id}/journeys/{journey_id}/milestones": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journeys-{journey_id}-milestones", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey milestone", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-journeys-{journey_id}-milestones", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "First hearing" }, "schema": { "properties": { "title": { "example": "First hearing", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post journey milestone", "tags": [] } }, "/orgs/{org_id}/journeys/{journey_id}/milestones/{milestone_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-journeys-{journey_id}-milestones-{milestone_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete journey milestone", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-journeys-{journey_id}-milestones-{milestone_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get journey milestone", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-journeys-{journey_id}-milestones-{milestone_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "journey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "milestone_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "New title" }, "schema": { "properties": { "title": { "anyOf": [ { "example": "New title", "type": "string" }, { "example": 1, "type": "integer" } ] }, "unknown": { "example": "attr", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch journey milestone", "tags": [] } }, "/orgs/{org_id}/locations": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "info_text": "", "lat": 1.0, "lng": 1.0, "organization": { "id": 1, "title": "My Organization" }, "title": "Haubtstrasse" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#18" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location", "tags": ["Maps"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-locations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "", "lat": 1.0, "lng": 1.0, "title": "New location example_string" }, "schema": { "properties": { "info_text": { "example": "", "type": "string" }, "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" }, "title": { "example": "New location example_string", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "info_text": "", "lat": 1.0, "lng": 1.0, "organization": { "id": 1, "title": "My Organization" }, "title": "New location example_string" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#18" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"type\" parameter is invalid. Wrong key 'type' in {'title': 'New location example_string', 'info_text': '', 'lat': 10.1, 'lng': 20.2, 'type': 'assignment'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post location", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "info_text": "", "organization": { "id": 1, "title": "My Organization" }, "title": "South" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location tag", "tags": ["Maps"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-locations-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "", "title": "New tag" }, "schema": { "properties": { "info_text": { "example": "", "type": "string" }, "title": { "example": "New tag", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "info_text": "", "organization": { "id": 1, "title": "My Organization" }, "title": "New tag" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#3" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post location tag", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-locations-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete location tag", "tags": ["Maps"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location tag", "tags": ["Maps"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-locations-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "New info text", "title": "New title" }, "schema": { "properties": { "info_text": { "example": "New info text", "type": "string" }, "invalid": { "example": "param", "type": "string" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch location tag", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/tags/{tag_id}/locations": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-tags-{tag_id}-locations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location tag location", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/{loc_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-locations-{loc_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete location", "tags": ["Maps"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-{loc_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location", "tags": ["Maps"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-locations-{loc_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "lat": 1.0, "lng": 1.0, "title": "New title example_string" }, "schema": { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" }, "title": { "example": "New title example_string", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"type\" parameter is invalid. Wrong key 'type' in {'title': 'Updated title', 'type': 'assignment'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch location", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/{loc_id}/actions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-{loc_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location action", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/{loc_id}/activities": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-{loc_id}-activities", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location activity", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/{loc_id}/tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-locations-{loc_id}-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get location location tag", "tags": ["Maps"] } }, "/orgs/{org_id}/locations/{loc_id}/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-locations-{loc_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete location location tag", "tags": ["Maps"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-locations-{loc_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "loc_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put location location tag", "tags": ["Maps"] } }, "/orgs/{org_id}/merges": { "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-merges", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "objects": [1], "type": "person" }, "schema": { "properties": { "objects": { "$ref": "#/components/schemas/Organizations" }, "override": { "$ref": "#/components/schemas/Error#2" }, "type": { "example": "person", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": "dummy@example.com", "ext_id": null, "first_name": "Tobe", "gender": null, "id": 1, "is_user": 1, "last_name": "abc123", "phone": null, "street_address": null, "zip_code": null } }, "schema": { "properties": { "data": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "example": "dummy@example.com", "type": "string" }, "ext_id": { "type": "null" }, "first_name": { "example": "Tobe", "type": "string" }, "gender": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "abc123", "type": "string" }, "phone": { "type": "null" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Malformed data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post merge", "tags": ["People"] } }, "/orgs/{org_id}/officials": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-officials", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "first_name": "Angela", "id": 1, "last_name": "Davis", "role": "admin" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Problems" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get official", "tags": ["Organizations"] } }, "/orgs/{org_id}/officials/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-officials-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Cannot demote yourself" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Delete official", "tags": ["Organizations"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-officials-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "first_name": "Angela", "id": 1, "last_name": "Davis", "role": "admin" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/User" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get official", "tags": ["Organizations"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-officials-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "role": "organizer" }, "schema": { "properties": { "role": { "example": "admin", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "first_name": "Niklas", "id": 1, "last_name": "Uv", "role": "admin" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/User" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"role\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Cannot promote above yourself" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Cannot demote yourself" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Put official", "tags": ["Organizations"] } }, "/orgs/{org_id}/people": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "custom_field": null, "email": "testadmin@example.com", "ext_id": null, "extra_data": { "foo": "bar" }, "extra_date": "1857-07-05", "extra_text": "This is a dummy text", "extra_url": "https://zetk.in", "first_name": "Angela", "gender": "f", "id": 1, "is_user": 1, "last_name": "Davis", "phone": "+4675463729", "shared": null, "street_address": null, "zip_code": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "custom_field": { "type": "null" }, "email": { "example": "testadmin@example.com", "type": "string" }, "ext_id": { "type": "null" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "extra_date": { "example": "1857-07-05", "type": "string" }, "extra_text": { "example": "This is a dummy text", "type": "string" }, "extra_url": { "example": "https://zetk.in", "type": "string" }, "first_name": { "example": "Angela", "type": "string" }, "gender": { "example": "f", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Davis", "type": "string" }, "org_4_url": { "type": "null" }, "phone": { "example": "+4675463729", "type": "string" }, "shared": { "type": "null" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get person", "tags": ["People"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "first_name": "Person", "last_name": "With Url", "test_url_field": "http://validurl.com" }, "schema": { "properties": { "alt_phone": { "example": "+46707654321", "type": "string" }, "email": { "example": " dummy@example.com ", "type": "string" }, "enum_field": { "example": "dummy", "type": "string" }, "ext_id": { "example": "example_string", "type": "string" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "first_name": { "example": "New", "type": "string" }, "last_name": { "example": "Person", "type": "string" }, "phone": { "example": "+46701234567", "type": "string" }, "test_date_field": { "example": "1857-07-05", "type": "string" }, "test_lnglat_field": { "$ref": "#/components/schemas/Location" }, "test_url_field": { "example": "http://validurl.com", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "alt_phone": "+46707654321", "city": null, "co_address": null, "country": null, "custom_field": null, "email": null, "ext_id": null, "extra_data": null, "extra_date": null, "extra_text": null, "extra_url": null, "first_name": "New", "gender": null, "id": 1, "is_user": 1, "last_name": "Person", "phone": "+46701234567", "shared": null, "street_address": null, "zip_code": null } }, "schema": { "properties": { "data": { "properties": { "alt_phone": { "anyOf": [ { "example": "+46707654321", "type": "string" }, { "type": "null" } ] }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "custom_field": { "type": "null" }, "email": { "anyOf": [ { "type": "null" }, { "example": " dummy@example.com ", "type": "string" } ] }, "enum_field": { "anyOf": [ { "example": "dummy", "type": "string" }, { "type": "null" } ] }, "ext_id": { "anyOf": [ { "type": "null" }, { "example": "example_string", "type": "string" } ] }, "extra_data": { "anyOf": [ { "type": "null" }, { "properties": { "custom": { "example": "json", "type": "string" } }, "type": "object" } ] }, "extra_date": { "type": "null" }, "extra_text": { "type": "null" }, "extra_url": { "type": "null" }, "first_name": { "example": "New", "type": "string" }, "gender": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Person", "type": "string" }, "org_4_url": { "type": "null" }, "parent_org_field": { "type": "null" }, "phone": { "anyOf": [ { "example": "+46701234567", "type": "string" }, { "type": "null" } ] }, "shared": { "type": "null" }, "street_address": { "type": "null" }, "test_date_field": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "type": "null" } ] }, "test_lnglat_field": { "anyOf": [ { "properties": { "lat": { "example": 1.0, "type": "number" }, "lng": { "example": 1.0, "type": "number" } }, "type": "object" }, { "type": "null" } ] }, "test_url_field": { "example": "http://validurl.com", "type": "string" }, "zip_code": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"last_name\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post person", "tags": ["People"] } }, "/orgs/{org_id}/people/duplicates": { "get": { "deprecated": false, "description": "Retrieve a list of potential duplicates", "operationId": "get--orgs-{org_id}-people-duplicates", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "dismissed": null, "duplicates": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": null, "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "is_user": 1, "last_name": "Zetkin", "phone": null, "street_address": null, "zip_code": null } ], "id": 1, "merged": null, "organization": { "id": 1, "title": "test" }, "status": "pending" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#11" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get duplicate", "tags": ["People"] } }, "/orgs/{org_id}/people/duplicates/{duplicate_id}": { "get": { "deprecated": false, "description": "Get a single potential duplicate", "operationId": "get--orgs-{org_id}-people-duplicates-{duplicate_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "duplicate_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "dismissed": null, "duplicates": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": null, "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "is_user": 1, "last_name": "Zetkin", "phone": null, "street_address": null, "zip_code": null } ], "id": 1, "merged": null, "organization": { "id": 1, "title": "test" }, "status": "pending" } }, "schema": { "properties": { "data": { "properties": { "dismissed": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "duplicates": { "$ref": "#/components/schemas/Duplicates" }, "id": { "example": 1, "type": "integer" }, "merged": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "organization": { "$ref": "#/components/schemas/Organization" }, "status": { "example": "pending", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get duplicate", "tags": ["People"] }, "patch": { "deprecated": false, "description": "Get a single potential duplicate", "operationId": "patch--orgs-{org_id}-people-duplicates-{duplicate_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "duplicate_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "dismissed": 1 }, "schema": { "properties": { "dismissed": { "example": 1, "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "dismissed": null, "duplicates": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": null, "ext_id": null, "first_name": "Clara", "gender": null, "id": 1, "is_user": 1, "last_name": "Zetkin", "phone": null, "street_address": null, "zip_code": null } ], "id": 1, "merged": null, "organization": { "id": 1, "title": "test" }, "status": "pending" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#11" } }, "type": "object" } } }, "description": "Example response for status 200" }, "409": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 409" } }, "summary": "Patch duplicate", "tags": ["People"] } }, "/orgs/{org_id}/people/fields": { "get": { "deprecated": false, "description": "Returns a list of existing custom field configurations.", "operationId": "get--orgs-{org_id}-people-fields", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "description": "Contains extra data as date", "enum_choices": null, "id": 1, "org_read": "sameorg", "org_write": "sameorg", "organization": { "id": 1, "title": "example_string" }, "slug": "extra_date", "title": "Extra date", "type": "date" } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Field" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person field", "tags": ["People"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-fields", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "slug": "new_field", "title": "New field", "type": "json" }, "schema": { "properties": { "enum_choices": { "$ref": "#/components/schemas/EnumChoices" }, "org_read": { "example": "suborgs", "type": "string" }, "org_write": { "example": "suborgs", "type": "string" }, "slug": { "example": "new_field", "type": "string" }, "title": { "example": "New field", "type": "string" }, "type": { "example": "json", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "description": "", "enum_choices": null, "id": 1, "org_read": "sameorg", "org_write": "sameorg", "organization": { "id": 1, "title": "example_string" }, "slug": "new_field", "title": "New field", "type": "json" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Field" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "Field with this slug already exists", "title": "Slug in use" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post person field", "tags": ["People"] } }, "/orgs/{org_id}/people/fields/{field_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person field", "tags": ["People"] }, "get": { "deprecated": false, "description": "Returns a single custom field configuration.", "operationId": "get--orgs-{org_id}-people-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person field", "tags": ["People"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "enum_choices": [ { "key": "dummy", "label": "Changed choice" } ] }, "schema": { "properties": { "enum_choices": { "$ref": "#/components/schemas/EnumChoices" }, "org_read": { "example": "suborgs", "type": "string" }, "org_write": { "example": "suborgs", "type": "string" }, "slug": { "example": "updated_slug", "type": "string" }, "title": { "example": "Updated title", "type": "string" }, "unknown_attr": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "description": null, "enum_choices": [ { "key": "dummy", "label": "Changed choice" } ], "id": 1, "org_read": "sameorg", "org_write": "sameorg", "organization": { "id": 1, "title": "example_string" }, "slug": "dummy_enum", "title": "Dummy enum", "type": "enum" } }, "schema": { "properties": { "data": { "properties": { "description": { "type": "null" }, "enum_choices": { "$ref": "#/components/schemas/EnumChoices" }, "id": { "example": 1, "type": "integer" }, "org_read": { "example": "sameorg", "type": "string" }, "org_write": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "slug": { "example": "dummy_enum", "type": "string" }, "title": { "example": "Dummy enum", "type": "string" }, "type": { "example": "enum", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "another", "title": "enum choice in use" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Patch person field", "tags": ["People"] } }, "/orgs/{org_id}/people/fields/{field_id}/uniquevalues": { "get": { "deprecated": false, "description": "Returns unique values of specified field", "operationId": "get--orgs-{org_id}-people-fields-{field_id}-uniquevalues", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": ["First value"] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/AllowedGrants" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person field unique values", "tags": ["People"] } }, "/orgs/{org_id}/people/queries": { "get": { "deprecated": false, "description": "Returns a list of objects (see below) containing the person query objects, for the organization with the query type \"standalone\".", "operationId": "get--orgs-{org_id}-people-queries", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "properties": { "filter_spec": { "items": { "properties": { "config": { "$ref": "#/components/schemas/Config#2" }, "type": { "example": "person_data", "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "All people with \"david\" in first or last name.", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "People named David", "type": "string" }, "type": { "example": "standalone", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person query", "tags": ["Search"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-queries", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "filter_spec": [ { "config": {}, "op": "add", "type": "task" } ], "info_text": "Dummy info text", "title": "Dummy title" }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#6" }, "info_text": { "example": "Dummy info text", "type": "string" }, "title": { "example": "Dummy title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ], "id": 1, "info_text": "Dummy info text", "org_access": "sameorg", "organization": { "id": 1, "title": "example_string" }, "title": "Dummy title", "type": "standalone" } }, "schema": { "properties": { "data": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#6" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "Dummy info text", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Dummy title", "type": "string" }, "type": { "example": "standalone", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid filter format" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person query", "tags": ["Search"] } }, "/orgs/{org_id}/people/queries/{query_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-queries-{query_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person query", "tags": ["Search"] }, "get": { "deprecated": false, "description": "Returns a person query item.\n\nThe query item is an object that consists of an _id_, _type_, _title_, _info_text_ and _filter_spec_. The type is always \"standalone\" (when retrieved from this endpoint).\n\nThe filter_spec consists of an array of filters that are described [here](/reference/api/smartsearches/).\n\nExample:\n```json\n{\n \"id\": \"1\",\n \"type\" : \"standalone\"\n \"title\": \"example\"\n \"info_text\": \"some info text\",\n \"org_access\": \"suborgs\",\n \"filter_spec\":\n [{\n \"op\": \"add\"\n \"type\": \"person_data\",\n \"config\": {\n \"fields\": {\n \"first_name\": \"Clara\",\n \"last_name\": \"Zetkin\"\n },\n \"organizationChoice\": \"specific\",\n \"specificOrganizations\": [1,2,3],\n }\n },\n {\n \"op\": \"add\"\n \"type\": \"person_tags\",\n \"config\": {\n \"condition\": \"none\",\n \"tags\": [1, 2, 3]\n }\n }]\n}\n```", "operationId": "get--orgs-{org_id}-people-queries-{query_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person query", "tags": ["Search"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-queries-{query_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "New title" }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#7" }, "info_text": { "example": "foo", "type": "string" }, "org_access": { "example": "suborgs", "type": "string" }, "title": { "example": "New title", "type": "string" }, "unknown_field": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid filter format" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person query", "tags": ["Search"] } }, "/orgs/{org_id}/people/queries/{query_id}/matches": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-queries-{query_id}-matches", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": "testadmin@example.com", "ext_id": null, "first_name": "Angela", "gender": "f", "id": 1, "is_user": 1, "last_name": "Davis", "phone": "+4675463729", "street_address": null, "zip_code": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "anyOf": [ { "example": "testorganizer@example.com", "type": "string" }, { "type": "null" } ] }, "ext_id": { "type": "null" }, "first_name": { "example": "Rosa", "type": "string" }, "gender": { "anyOf": [ { "example": "f", "type": "string" }, { "type": "null" } ] }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Luxemburg", "type": "string" }, "phone": { "anyOf": [ { "example": "+4675463728", "type": "string" }, { "type": "null" } ] }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person query match", "tags": ["Search"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-queries-{query_id}-matches", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "ephemeral", "in": "path", "name": "query_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "filter_spec": [ { "config": { "operator": "in", "survey": 1, "value": "response" }, "type": "survey_response" } ] }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#2" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "alt_phone": null, "city": null, "co_address": null, "country": null, "email": "testadmin@example.com", "ext_id": null, "first_name": "Angela", "gender": "f", "id": 1, "is_user": 1, "last_name": "Davis", "phone": "+4675463729", "street_address": null, "zip_code": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#19" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid filter list" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" } }, "summary": "Post person query match", "tags": ["Search"] } }, "/orgs/{org_id}/people/queries/{query_id}/matches/{person_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-queries-{query_id}-matches-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person query match", "tags": ["Search"] } }, "/orgs/{org_id}/people/queries/{query_id}/stats": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-queries-{query_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "query_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "change": 1, "filter": { "config": { "ancestorOrganizations": [1], "operator": "in", "organizations": [1], "view": 1 }, "op": "add", "type": "person_view" }, "matches": 1, "result": 1 } ] }, "schema": { "properties": { "data": { "items": { "properties": { "change": { "example": 1, "type": "integer" }, "filter": { "properties": { "config": { "$ref": "#/components/schemas/Config#5" }, "op": { "example": "add", "type": "string" }, "type": { "example": "person_view", "type": "string" } }, "type": "object" }, "matches": { "example": 1, "type": "integer" }, "result": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person query stats", "tags": ["Search"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-queries-{query_id}-stats", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "ephemeral", "in": "path", "name": "query_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "filter_spec": [ { "config": { "seed": "", "size": 1 }, "type": "random" } ] }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#3" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "change": 1, "filter": { "config": { "ancestorOrganizations": [1], "organizations": [1], "seed": "", "size": 1 }, "type": "random" }, "matches": 1, "result": 1 } ] }, "schema": { "properties": { "data": { "items": { "properties": { "change": { "example": 1, "type": "integer" }, "filter": { "properties": { "config": { "$ref": "#/components/schemas/Config#5" }, "type": { "example": "random", "type": "string" } }, "type": "object" }, "matches": { "example": 1, "type": "integer" }, "result": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid filter list" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" } }, "summary": "Post person query stats", "tags": ["Search"] } }, "/orgs/{org_id}/people/tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "color": null, "description": "", "group": { "id": 1, "title": "Member type" }, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Activist", "value_type": "url" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "color": { "type": "null" }, "description": { "example": "", "type": "string" }, "group": { "$ref": "#/components/schemas/Organization" }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Activist", "type": "string" }, "value_type": { "example": "url", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person tag", "tags": ["People"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "color": "#ffcc00", "description": "Updated description", "hidden": 1, "title": "Updated title", "value_type": "text" }, "schema": { "properties": { "color": { "example": "#ffcc00", "type": "string" }, "description": { "example": "Updated description", "type": "string" }, "group_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] }, "hidden": { "example": 1, "type": "integer" }, "title": { "example": "Updated title", "type": "string" }, "value_type": { "example": "text", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "color": "#ffcc00", "description": "Updated description", "group": null, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Updated title", "value_type": null } }, "schema": { "properties": { "data": { "properties": { "color": { "example": "#ffcc00", "type": "string" }, "description": { "example": "Updated description", "type": "string" }, "group": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "Member type", "type": "string" } }, "type": "object" } ] }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Updated title", "type": "string" }, "value_type": { "anyOf": [ { "type": "null" }, { "example": "text", "type": "string" } ] } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person tag", "tags": ["People"] } }, "/orgs/{org_id}/people/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person tag", "tags": ["People"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "color": null, "description": "", "group": null, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "With deleted group", "value_type": null } }, "schema": { "properties": { "data": { "properties": { "color": { "type": "null" }, "description": { "example": "", "type": "string" }, "group": { "type": "null" }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "With deleted group", "type": "string" }, "value_type": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person tag", "tags": ["People"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "color": "#ffcc00", "description": "Updated description", "hidden": 1, "title": "Updated title" }, "schema": { "properties": { "color": { "anyOf": [ { "example": "#ffcc00", "type": "string" }, { "type": "null" } ] }, "description": { "example": "Updated description", "type": "string" }, "group_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] }, "hidden": { "example": 1, "type": "integer" }, "title": { "example": "Updated title", "type": "string" }, "value_type": { "example": "text", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'color' error:\nOr(None, And(, at 0x7db2723cec10>)) did not validate 'invalidcolor'\n('invalidcolor') should evaluate to True\" parameter is invalid. Key 'color' error:\nOr(None, And(, at 0x7db2723cec10>)) did not validate 'invalidcolor'\n('invalidcolor') should evaluate to True", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person tag", "tags": ["People"] } }, "/orgs/{org_id}/people/tags/{tag_id}/people": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-tags-{tag_id}-people", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person tag person", "tags": ["People"] } }, "/orgs/{org_id}/people/view_folders": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-view_folders", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "organization": { "id": 1, "title": "example_string" }, "parent": null, "title": "Static views" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#2" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view folder", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-view_folders", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "parent_id": 1, "title": "Folder" }, "schema": { "properties": { "parent_id": { "example": 1, "type": "integer" }, "title": { "example": "Folder", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "organization": { "id": 1, "title": "example_string" }, "parent": null, "title": "Folder" } }, "schema": { "properties": { "data": { "properties": { "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "parent": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "Static views", "type": "string" } }, "type": "object" } ] }, "title": { "example": "Folder", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person view folder", "tags": [] } }, "/orgs/{org_id}/people/view_folders/{folder_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-view_folders-{folder_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "folder_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "renamed" }, "schema": { "properties": { "title": { "example": "renamed", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view folder", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-view_folders-{folder_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "folder_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": 1, "organization": { "id": 1, "title": "example_string" }, "parent": null, "title": "Child" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view folder", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-view_folders-{folder_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "folder_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "renamed" }, "schema": { "properties": { "parent_id": { "example": 1, "type": "integer" }, "title": { "example": "renamed", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person view folder", "tags": [] } }, "/orgs/{org_id}/people/views": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-views", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "content_query": null, "created": "1857-07-05T00:00:00.000000", "description": "This is my dummy view", "folder": { "id": 1, "title": "Static views" }, "id": 1, "organization": { "id": 1, "title": "example_string" }, "owner": { "id": 1, "name": "Clara Zetkin" }, "title": "My view" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "content_query": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "description": { "example": "This is my dummy view", "type": "string" }, "folder": { "$ref": "#/components/schemas/Organization" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "owner": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "My view", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view", "tags": ["Views"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-views", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "This is my test view", "owner_id": 1, "title": "My new view" }, "schema": { "properties": { "description": { "example": "This is my test view", "type": "string" }, "folder_id": { "example": 1, "type": "integer" }, "owner_id": { "example": 1, "type": "integer" }, "title": { "example": "My new view", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "content_query": null, "created": "1857-07-05T00:00:00.000000", "description": "This is my test view", "folder": null, "id": 1, "organization": { "id": 1, "title": "example_string" }, "owner": { "id": 1, "name": "Angela Davis" }, "title": "My new view" } }, "schema": { "properties": { "data": { "properties": { "content_query": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "description": { "example": "This is my test view", "type": "string" }, "folder": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "Static views", "type": "string" } }, "type": "object" } ] }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "owner": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "My new view", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person view", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-views-{view_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view", "tags": ["Views"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-views-{view_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "content_query": null, "created": "1857-07-05T00:00:00.000000", "description": null, "folder": null, "id": 1, "organization": { "id": 1, "title": "example_string" }, "owner": { "id": 1, "name": "Clara Zetkin" }, "title": "Deleted view" } }, "schema": { "properties": { "data": { "properties": { "content_query": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "description": { "type": "null" }, "folder": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "owner": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Deleted view", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view", "tags": ["Views"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-views-{view_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "New title" }, "schema": { "properties": { "folder_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person view", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/access": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-views-{view_id}-access", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view access", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/access/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-views-{view_id}-access-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Delete person view access", "tags": ["Views"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-people-views-{view_id}-access-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "level": "readonly" }, "schema": { "properties": { "level": { "example": "readonly", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'level' error:\nOr('readonly', 'edit', 'configure') did not validate 'invalid'\n'configure' does not match 'invalid'\" parameter is invalid. Key 'level' error:\nOr('readonly', 'edit', 'configure') did not validate 'invalid'\n'configure' does not match 'invalid'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person view access", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/column_order": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-views-{view_id}-column_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view column order", "tags": ["Views"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-views-{view_id}-column_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "order": [1] }, "schema": { "properties": { "order": { "$ref": "#/components/schemas/Organizations" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Malformed data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person view column order", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/columns": { "get": { "deprecated": false, "description": "Retrieve all columns in view `view_id`", "operationId": "get--orgs-{org_id}-people-views-{view_id}-columns", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view column", "tags": ["Views"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-views-{view_id}-columns", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "config": { "field": "email" }, "title": "My column", "type": "person_field" }, "schema": { "properties": { "config": { "properties": { "field": { "example": "email", "type": "string" }, "filter_spec": { "$ref": "#/components/schemas/FilterSpec#7" } }, "type": "object" }, "title": { "example": "My column", "type": "string" }, "type": { "example": "person_field", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "config": { "field": "email" }, "description": "", "id": 1, "title": "My column", "type": "person_field" } }, "schema": { "properties": { "data": { "properties": { "config": { "$ref": "#/components/schemas/Error" }, "description": { "example": "", "type": "string" }, "id": { "example": 1, "type": "integer" }, "title": { "example": "My column", "type": "string" }, "type": { "example": "person_field", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"field\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person view column", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/columns/{col_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-views-{view_id}-columns-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view column", "tags": ["Views"] }, "get": { "deprecated": false, "description": "Get column details.", "operationId": "get--orgs-{org_id}-people-views-{view_id}-columns-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view column", "tags": ["Views"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-views-{view_id}-columns-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "New title" }, "schema": { "properties": { "config": { "$ref": "#/components/schemas/Config#6" }, "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person view column", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/content_query": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-views-{view_id}-content_query", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view content query", "tags": ["People"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-views-{view_id}-content_query", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view content query", "tags": ["People"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-views-{view_id}-content_query", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ] }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#7" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ] } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Config#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "201": { "content": { "application/json": { "example": { "data": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ] } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Config#6" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'filter_spec': [{'type': 'all', 'op': 'add', 'config': {}}], 'invalid': True}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person view content query", "tags": ["People"] } }, "/orgs/{org_id}/people/views/{view_id}/rows": { "get": { "deprecated": false, "description": "Retrieves list of people that have been added to the view, formatted according\nto the configuration of the view, i.e. using the columns of the view.\n\nThe data returned will be formatted like this:\n\n```json\n[\n { \"id\": 1, \"content\": [ \"Alice\", \"Andersson\", \"alice@example.com\", true ] },\n { \"id\": 2, \"content\": [ \"Bob\", \"Boblaw\", \"bob@example.com\", false ] }\n]\n```\n\nWhere `id` is the ID of the person, and `content` contains the column-by-column\nvalues corresponding to that person. The order and type of the entries in the\n`content` array depends on the view column configuration.", "operationId": "get--orgs-{org_id}-people-views-{view_id}-rows", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "properties": { "content": { "$ref": "#/components/schemas/AllowedGrants" }, "id": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view row", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/rows/{person_id}": { "delete": { "deprecated": false, "description": "Delete a row (person identified by `person_id`) from the view. No actual\ndata is lost, regardless of column type.", "operationId": "delete--orgs-{org_id}-people-views-{view_id}-rows-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view row", "tags": ["Views"] }, "get": { "deprecated": false, "description": "Get single person from the view, formatted according to view configuration.", "operationId": "get--orgs-{org_id}-people-views-{view_id}-rows-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "content": [ [ { "submission_id": 1, "submitted": "1857-07-05T00:00:00.000000+0000", "text": "This is my response" } ] ], "id": 1 } }, "schema": { "properties": { "data": { "properties": { "content": { "items": { "items": { "properties": { "assignment": { "properties": { "id": { "example": 1, "type": "integer" }, "organization_id": { "example": 1, "type": "integer" }, "title": { "example": "First assignment", "type": "string" } }, "type": "object" }, "caller": { "$ref": "#/components/schemas/Config" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/Organization" }, "message_to_organizer": { "example": "Organizer action needed!", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "organizer_action_needed": { "example": 1, "type": "integer" }, "organizer_action_taken": { "type": "null" }, "selected": { "anyOf": [ { "example": 1, "type": "integer" }, { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "text": { "example": "abc123", "type": "string" } }, "type": "object" }, "type": "array" } ] }, "submission_id": { "example": 1, "type": "integer" }, "submitted": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" }, "text": { "example": "This is my response", "type": "string" }, "title": { "type": "null" }, "update_time": { "example": "1857-07-05T00:00:00.000000+0000", "type": "string" } }, "type": "object" }, "type": "array" }, "type": "array" }, "id": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view row", "tags": ["Views"] }, "put": { "deprecated": false, "description": "Add a row (person identified by `person_id`) to the view and return the\ndata for that person, formatted according to the view configuration.", "operationId": "put--orgs-{org_id}-people-views-{view_id}-rows-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "content": { "application/json": { "example": { "data": { "content": [1], "id": 1 } }, "schema": { "properties": { "data": { "properties": { "content": { "$ref": "#/components/schemas/Organizations" }, "id": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person view row", "tags": ["Views"] } }, "/orgs/{org_id}/people/views/{view_id}/rows/{person_id}/cells/{col_id}": { "delete": { "deprecated": false, "description": "Delete a cell (person identified by `person_id` and `col_id`) from the view.", "operationId": "delete--orgs-{org_id}-people-views-{view_id}-rows-{person_id}-cells-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person view cell", "tags": ["Views"] }, "get": { "deprecated": false, "description": "Get cell details.", "operationId": "get--orgs-{org_id}-people-views-{view_id}-rows-{person_id}-cells-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person view cell", "tags": ["Views"] }, "put": { "deprecated": false, "description": "Add a cell (identified by `person_id` and `col_id`) to the view and\nreturn the data for that cell.", "operationId": "put--orgs-{org_id}-people-views-{view_id}-rows-{person_id}-cells-{col_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "view_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "col_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "value": 1 }, "schema": { "properties": { "value": { "anyOf": [ { "example": 1, "type": "integer" }, { "example": "invalid", "type": "string" } ] } }, "type": "object" } } }, "required": false }, "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person view cell", "tags": ["Views"] } }, "/orgs/{org_id}/people/{person_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person", "tags": ["People"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "alt_phone": null, "ancestor_date_field": null, "city": null, "co_address": null, "country": null, "custom_field": null, "date-field": null, "dummy": null, "dummy_2": null, "dummy_enum": null, "dummy_text": "First value", "dummynonshared": null, "dummyshared": null, "email": "testadmin@example.com", "enum_field": null, "example_string": null, "ext_id": null, "extra_date": "1857-07-05", "extra_url": "https://zetk.in", "first_name": "Angela", "gender": "f", "id": 1, "is_user": 1, "last_name": "Davis", "new_field": null, "parent_org_field": "Dummy value", "phone": "+4675463729", "shared": null, "street_address": null, "test_date_field": null, "test_lnglat_field": null, "test_url_field": null, "text-field": null, "url-field": null, "zip_code": null } }, "schema": { "properties": { "data": { "properties": { "alt_phone": { "type": "null" }, "ancestor_date_field": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "custom_field": { "type": "null" }, "date-field": { "type": "null" }, "dummy": { "type": "null" }, "dummy_2": { "type": "null" }, "dummy_enum": { "type": "null" }, "dummy_text": { "anyOf": [ { "type": "null" }, { "example": "First value", "type": "string" } ] }, "dummynonshared": { "type": "null" }, "dummyshared": { "type": "null" }, "email": { "example": "testorganizer@example.com", "type": "string" }, "enum_field": { "type": "null" }, "example_string": { "type": "null" }, "ext_id": { "type": "null" }, "extra_data": { "anyOf": [ { "type": "null" }, { "properties": { "foo": { "example": "bar", "type": "string" } }, "type": "object" } ] }, "extra_date": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05", "type": "string" } ] }, "extra_text": { "anyOf": [ { "type": "null" }, { "example": "This is a dummy text", "type": "string" } ] }, "extra_url": { "anyOf": [ { "type": "null" }, { "example": "https://zetk.in", "type": "string" } ] }, "first_name": { "example": "Rosa", "type": "string" }, "gender": { "example": "f", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Luxemburg", "type": "string" }, "new_field": { "type": "null" }, "org_4_url": { "type": "null" }, "parent_org_field": { "anyOf": [ { "type": "null" }, { "example": "Dummy value", "type": "string" } ] }, "phone": { "example": "+4675463728", "type": "string" }, "shared": { "type": "null" }, "street_address": { "type": "null" }, "test_date_field": { "type": "null" }, "test_lnglat_field": { "type": "null" }, "test_url_field": { "type": "null" }, "text-field": { "type": "null" }, "url-field": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person", "tags": ["People"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "enum_field": null }, "schema": { "properties": { "alt_phone": { "example": "0701234567", "type": "string" }, "city": { "anyOf": [ { "example": "example_string", "type": "string" }, { "type": "null" } ] }, "co_address": { "type": "null" }, "country": { "example": "Sweden", "type": "string" }, "email": { "example": "testuser@example.com", "type": "string" }, "enum_field": { "anyOf": [ { "example": "another", "type": "string" }, { "type": "null" } ] }, "ext_id": { "example": "example_string", "type": "string" }, "extra_data": { "properties": { "new": { "anyOf": [ { "example": 1, "type": "integer" }, { "example": "example_string", "type": "string" } ] } }, "type": "object" }, "first_name": { "example": "Jane", "type": "string" }, "gender": { "example": "f", "type": "string" }, "last_name": { "example": "Doe", "type": "string" }, "parent_org_field": { "example": "Dummy text", "type": "string" }, "phone": { "example": "0787654321", "type": "string" }, "street_address": { "type": "null" }, "test_date_field": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05", "type": "string" } ] }, "test_lnglat_field": { "$ref": "#/components/schemas/Location" }, "test_url_field": { "example": "http://validurl.com", "type": "string" }, "unknownproperty": { "example": 1, "type": "integer" }, "zip_code": { "type": "null" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "alt_phone": null, "ancestor_date_field": null, "city": null, "co_address": null, "country": null, "custom_field": null, "date-field": null, "dummy": null, "dummy_2": null, "dummy_enum": null, "dummy_text": "First value", "dummynonshared": null, "dummyshared": null, "email": "testadmin@example.com", "enum_field": null, "example_string": null, "ext_id": null, "extra_date": "1857-07-05", "extra_url": "https://zetk.in", "first_name": "Angela", "gender": "f", "id": 1, "is_user": 1, "last_name": "Davis", "new_field": null, "parent_org_field": null, "phone": "+4675463729", "shared": null, "street_address": null, "test_date_field": null, "test_lnglat_field": null, "test_url_field": null, "text-field": null, "url-field": null, "zip_code": null } }, "schema": { "properties": { "data": { "properties": { "alt_phone": { "type": "null" }, "ancestor_date_field": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "custom_field": { "type": "null" }, "date-field": { "type": "null" }, "dummy": { "type": "null" }, "dummy_2": { "type": "null" }, "dummy_enum": { "type": "null" }, "dummy_text": { "example": "First value", "type": "string" }, "dummynonshared": { "type": "null" }, "dummyshared": { "type": "null" }, "email": { "example": "testadmin@example.com", "type": "string" }, "enum_field": { "anyOf": [ { "example": "another", "type": "string" }, { "type": "null" } ] }, "example_string": { "type": "null" }, "ext_id": { "type": "null" }, "extra_data": { "$ref": "#/components/schemas/Error" }, "extra_date": { "example": "1857-07-05", "type": "string" }, "extra_text": { "example": "This is a dummy text", "type": "string" }, "extra_url": { "example": "https://zetk.in", "type": "string" }, "first_name": { "example": "Angela", "type": "string" }, "gender": { "example": "f", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Davis", "type": "string" }, "new_field": { "type": "null" }, "parent_org_field": { "anyOf": [ { "type": "null" }, { "example": "Dummy value", "type": "string" } ] }, "phone": { "example": "+4675463729", "type": "string" }, "shared": { "type": "null" }, "street_address": { "type": "null" }, "test_date_field": { "type": "null" }, "test_lnglat_field": { "type": "null" }, "test_url_field": { "type": "null" }, "text-field": { "type": "null" }, "url-field": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "400 Bad Request" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/avatar": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-avatar", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "303": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 303" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person avatar", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/connections": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-connections", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person connection", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/connections/{conn_org_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-{person_id}-connections-{conn_org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "conn_org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person connection", "tags": ["People"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-people-{person_id}-connections-{conn_org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "conn_org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person connection", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/fields": { "get": { "deprecated": false, "description": "Get values for all fields that have been set on this person.", "operationId": "get--orgs-{org_id}-people-{person_id}-fields", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "field": { "description": "Contains extra data as text", "enum_choices": null, "id": 1, "org_read": "sameorg", "org_write": "sameorg", "organization": { "id": 1, "title": "example_string" }, "slug": "extra_text", "title": "Extra text", "type": "text" }, "value": "This is a dummy text" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "field": { "$ref": "#/components/schemas/Field" }, "value": { "anyOf": [ { "properties": { "foo": { "example": "bar", "type": "string" } }, "type": "object" }, { "example": "This is a dummy text", "type": "string" } ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person field value", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/fields/{field_id}": { "delete": { "deprecated": false, "description": "Delete (unset) the value of field `field_id` (ID or slug) for this person.\n\nTrying to delete a value for a field which has not been set will return a\n404 (Not found) error code.\n\nAs an alternative, you can `PUT` an empty value which will also cause the\nfield to be unset, but always returns 204 (No Content).", "operationId": "delete--orgs-{org_id}-people-{person_id}-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person field value", "tags": ["People"] }, "get": { "deprecated": false, "description": "Get value of field `field_id` (ID or slug) for this person. The value\nis returned as the `data` property of the response, or null if no value\nhas been set.", "operationId": "get--orgs-{org_id}-people-{person_id}-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person field value", "tags": ["People"] }, "put": { "deprecated": false, "description": "Set or update the value of field `field_id` (ID or slug) for this person.\n\nThe request body will be parsed as JSON and assigned to the field. This\nmeans that the content can be anything allowed in JSON, including objects\nand lists (if the type of the field is `json`).\n\nA null/empty value will unset the field for this person. This is similar\nto `DELETE`, but will not return 404 if the value is not already set.", "operationId": "put--orgs-{org_id}-people-{person_id}-fields-{field_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "field_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": "dummy", "schema": { "anyOf": [ { "properties": { "foo": { "example": "new-value", "type": "string" }, "reset": { "example": "value", "type": "string" } }, "type": "object" }, { "example": 1, "type": "integer" }, { "example": "invalid url", "type": "string" } ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": "dummy" }, "schema": { "properties": { "data": { "example": "dummy", "type": "string" } }, "type": "object" } } }, "description": "Example response for status 200" }, "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "400": { "content": { "application/json": { "example": { "error": { "description": "invalid date", "title": "Invalid date string value" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person field value", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/journey_instances": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-journey_instances", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assignees": [], "closed": null, "created": "1857-07-05T00:00:00.000000", "id": 1, "journey": { "id": 1, "plural_label": "Cases", "singular_label": "Case", "title": "Case" }, "next_milestone": { "completed": null, "deadline": null, "description": "", "id": 1, "title": "Evidence collected" }, "opening_note": "", "organization": { "id": 1, "title": "example_string" }, "outcome": "", "subjects": [ { "first_name": "Rosa", "id": 1, "last_name": "Westlund" } ], "summary": "", "tags": [], "title": null, "updated": null } ] }, "schema": { "properties": { "data": { "items": { "properties": { "assignees": { "$ref": "#/components/schemas/FilterSpec" }, "closed": { "type": "null" }, "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "id": { "example": 1, "type": "integer" }, "journey": { "$ref": "#/components/schemas/User" }, "next_milestone": { "$ref": "#/components/schemas/NextMilestone" }, "opening_note": { "example": "", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "outcome": { "example": "", "type": "string" }, "subjects": { "$ref": "#/components/schemas/Subjects" }, "summary": { "example": "", "type": "string" }, "tags": { "$ref": "#/components/schemas/FilterSpec" }, "title": { "type": "null" }, "updated": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person journey instance", "tags": [] } }, "/orgs/{org_id}/people/{person_id}/notes": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-notes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#17" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person note", "tags": ["People"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-people-{person_id}-notes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "This is the note" }, "schema": { "properties": { "text": { "example": "This is the note", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "author": { "id": 1, "name": "Angela Davis" }, "created": "1857-07-05T00:00:00.000000", "files": [], "id": 1, "organization": { "id": 1, "title": "example_string" }, "text": "This is the note" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#17" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post person note", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/notes/{note_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-{person_id}-notes-{note_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "note_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person note", "tags": ["People"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-people-{person_id}-notes-{note_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "note_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "This is the updated note" }, "schema": { "properties": { "file_ids": { "$ref": "#/components/schemas/Organizations" }, "text": { "example": "This is the updated note", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch person note", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/tags": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-tags", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "color": null, "description": "", "group": { "id": 1, "title": "Member type" }, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Activist", "value": null, "value_type": null } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Tags#2" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person person tag", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/tags/{tag_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-people-{person_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete person person tag", "tags": ["People"] }, "put": { "deprecated": false, "description": "", "operationId": "put--orgs-{org_id}-people-{person_id}-tags-{tag_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "tag_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "value": "https://zetk.in" }, "schema": { "properties": { "value": { "anyOf": [ { "example": "1857-07-05", "type": "string" }, { "properties": { "test": { "example": 1, "type": "integer" } }, "type": "object" }, { "example": 1, "type": "integer" } ] } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "color": null, "description": "", "group": { "id": 1, "title": "Member type" }, "hidden": 1, "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Activist", "value": "https://zetk.in", "value_type": "url" } }, "schema": { "properties": { "data": { "properties": { "color": { "type": "null" }, "description": { "example": "", "type": "string" }, "group": { "$ref": "#/components/schemas/Organization" }, "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "title": { "example": "Activist", "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05", "type": "string" }, { "properties": { "test": { "example": 1, "type": "integer" } }, "type": "object" }, { "example": 1, "type": "integer" } ] }, "value_type": { "anyOf": [ { "type": "null" }, { "example": "date", "type": "string" } ] } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "test", "title": "Invalid URL string value" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put person person tag", "tags": ["People"] } }, "/orgs/{org_id}/people/{person_id}/timeline": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-people-{person_id}-timeline", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get person timeline", "tags": ["People"] } }, "/orgs/{org_id}/search/{data_type}": { "post": { "deprecated": false, "description": "The query must be sent as request data on the form\n```json\n{ \"q\": \"abc123\" }\n```\nwhere _abc123_ is the search string", "operationId": "post--orgs-{org_id}-search-{data_type}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "person", "in": "path", "name": "data_type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "q": "thiscannotpossiblymatchanythinginthedatabase" }, "schema": { "properties": { "q": { "example": "clara", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#19" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing query" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post search", "tags": ["Search"] } }, "/orgs/{org_id}/sub_organizations": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-sub_organizations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "avatar_file": null, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": null, "parent": { "id": 1, "slug": "myorg", "title": "example_string" }, "phone": null, "short_title": null, "slug": "myotherorg", "sub_orgs": [ { "avatar_file": null, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": null, "parent": { "id": 1, "slug": "myotherorg", "title": "My Other Organization" }, "phone": null, "short_title": null, "slug": null, "sub_orgs": [], "title": "Dummy suborg of org 2" } ], "title": "My Other Organization" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "type": "null" }, "parent": { "$ref": "#/components/schemas/Config" }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "example": "myotherorg", "type": "string" }, "sub_orgs": { "items": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "type": "null" }, "parent": { "$ref": "#/components/schemas/Config" }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "type": "null" }, "sub_orgs": { "$ref": "#/components/schemas/FilterSpec" }, "title": { "example": "Dummy suborg of org 2", "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "example": "My Other Organization", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" } }, "summary": "Get org sub org", "tags": ["Organizations"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-sub_organizations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "country": "SE", "title": "My new organization" }, "schema": { "properties": { "country": { "example": "SE", "type": "string" }, "location": { "$ref": "#/components/schemas/Location" }, "title": { "example": "My new organization", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "avatar_file": null, "country": "SE", "email": null, "id": 1, "is_active": 1, "is_open": 1, "is_public": 1, "lang": null, "location": null, "parent": { "id": 1, "slug": "myorg", "title": "example_string" }, "phone": null, "short_title": null, "slug": null, "title": "My new organization" } }, "schema": { "properties": { "data": { "properties": { "avatar_file": { "type": "null" }, "country": { "example": "SE", "type": "string" }, "email": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "is_active": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "is_public": { "example": 1, "type": "integer" }, "lang": { "type": "null" }, "location": { "type": "null" }, "parent": { "$ref": "#/components/schemas/Config" }, "phone": { "type": "null" }, "short_title": { "type": "null" }, "slug": { "type": "null" }, "title": { "example": "My new organization", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Incorrectly formatted data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post org sub org", "tags": ["Organizations"] } }, "/orgs/{org_id}/survey_submissions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-survey_submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "organization": { "id": 1, "title": "example_string" }, "respondent": null, "submitted": null, "survey": { "id": 1, "title": "A very open survey" } } ] }, "schema": { "properties": { "data": { "items": { "properties": { "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "respondent": { "anyOf": [ { "type": "null" }, { "properties": { "email": { "example": "dummy@example.com", "type": "string" }, "first_name": { "example": "Dummy", "type": "string" }, "id": { "example": 1, "type": "integer" }, "last_name": { "example": "Person", "type": "string" } }, "type": "object" } ] }, "submitted": { "type": "null" }, "survey": { "$ref": "#/components/schemas/Organization" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey submission", "tags": ["Survey"] } }, "/orgs/{org_id}/survey_submissions/{sub_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-survey_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete survey submission", "tags": ["Survey"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-survey_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": 1, "organization": { "id": 1, "title": "example_string" }, "respondent": null, "responses": [ { "options": [], "question_id": 1 } ], "submitted": null, "survey": { "id": 1, "title": "A very open survey" } } }, "schema": { "properties": { "data": { "properties": { "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "respondent": { "type": "null" }, "responses": { "items": { "$ref": "#/components/schemas/Target#4" }, "type": "array" }, "submitted": { "type": "null" }, "survey": { "$ref": "#/components/schemas/Organization" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey submission", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-survey_submissions-{sub_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "sub_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "respondent_id": 1 }, "schema": { "properties": { "respondent_id": { "anyOf": [ { "example": 1, "type": "integer" }, { "type": "null" } ] }, "unknown": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey submission", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "allow_anonymous": 1, "campaign": { "id": 1, "title": "Unpublihsed campaign" }, "expires": null, "id": 1, "info_text": "This is a survey", "org_access": "sameorg", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "signature": "allow_anonymous", "title": "A very open survey" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "access": { "example": "open", "type": "string" }, "allow_anonymous": { "example": 1, "type": "integer" }, "callers_only": { "example": 1, "type": "integer" }, "campaign": { "anyOf": [ { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "Unpublihsed campaign", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "This is a survey", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "A very open survey", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey", "tags": ["Survey"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-surveys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "access": "open", "callers_only": 1, "campaign_id": 1, "signature": "allow_anonymous", "title": "Test survey" }, "schema": { "properties": { "access": { "example": "open", "type": "string" }, "callers_only": { "example": 1, "type": "integer" }, "campaign_id": { "example": 1, "type": "integer" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "Test survey", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "access": "open", "allow_anonymous": 1, "callers_only": 1, "campaign": null, "expires": null, "id": 1, "info_text": "", "org_access": "sameorg", "organization": { "id": 1, "title": "example_string" }, "published": null, "signature": "allow_anonymous", "title": "Test survey" } }, "schema": { "properties": { "data": { "properties": { "access": { "example": "open", "type": "string" }, "allow_anonymous": { "example": 1, "type": "integer" }, "callers_only": { "example": 1, "type": "integer" }, "campaign": { "anyOf": [ { "type": "null" }, { "properties": { "id": { "example": 1, "type": "integer" }, "title": { "example": "First campaign in 1", "type": "string" } }, "type": "object" } ] }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "type": "null" }, "signature": { "example": "allow_anonymous", "type": "string" }, "title": { "example": "Test survey", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post survey", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-surveys-{survey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete survey", "tags": ["Survey"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "access": "list", "allow_anonymous": 1, "callers_only": 1, "campaign": null, "elements": [], "expires": null, "id": 1, "info_text": "", "org_access": "sameorg", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "signature": "require_signature", "title": "Closed survey" } }, "schema": { "properties": { "data": { "properties": { "access": { "example": "list", "type": "string" }, "allow_anonymous": { "example": 1, "type": "integer" }, "callers_only": { "example": 1, "type": "integer" }, "campaign": { "type": "null" }, "elements": { "$ref": "#/components/schemas/FilterSpec" }, "expires": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "info_text": { "example": "", "type": "string" }, "org_access": { "example": "sameorg", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "signature": { "example": "require_signature", "type": "string" }, "title": { "example": "Closed survey", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-surveys-{survey_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "info_text": "New summary", "title": "New title" }, "schema": { "properties": { "campaign_id": { "example": 1, "type": "integer" }, "expires": { "anyOf": [ { "example": "1857-07-05 00:00:00.000000", "type": "string" }, { "type": "null" } ] }, "info_text": { "example": "New summary", "type": "string" }, "title": { "example": "New title", "type": "string" }, "unknown_attr": { "example": "value", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/element_order": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-element_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey element order", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-surveys-{survey_id}-element_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "default": [1] }, "schema": { "properties": { "default": { "$ref": "#/components/schemas/Organizations" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Malformed data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey element order", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/elements": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-elements", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Not a member of organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey element", "tags": ["Survey"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-surveys-{survey_id}-elements", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "hidden": 1, "question": { "question": "Hidden question", "response_config": { "multiline": 1 }, "response_type": "text" }, "type": "question" }, "schema": { "properties": { "hidden": { "example": 1, "type": "integer" }, "question": { "properties": { "description": { "example": "A description", "type": "string" }, "options": { "$ref": "#/components/schemas/AllowedGrants" }, "question": { "example": "Hidden question", "type": "string" }, "response_config": { "$ref": "#/components/schemas/Config" }, "response_type": { "example": "text", "type": "string" } }, "type": "object" }, "text_block": { "$ref": "#/components/schemas/Error#2" }, "type": { "example": "text", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "hidden": 1, "id": 1, "text_block": { "content": null, "header": "First header" }, "type": "text" } }, "schema": { "properties": { "data": { "properties": { "hidden": { "example": 1, "type": "integer" }, "id": { "example": 1, "type": "integer" }, "question": { "properties": { "description": { "type": "null" }, "question": { "example": "Hidden question", "type": "string" }, "required": { "example": 1, "type": "integer" }, "response_config": { "$ref": "#/components/schemas/Action" }, "response_type": { "example": "text", "type": "string" } }, "type": "object" }, "text_block": { "properties": { "content": { "type": "null" }, "header": { "example": "First header", "type": "string" } }, "type": "object" }, "type": { "example": "text", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"question\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post survey survey element", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/elements/{elem_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete survey survey element", "tags": ["Survey"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey element", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "question": { "question": "New question text?" } }, "schema": { "properties": { "hidden": { "example": 1, "type": "integer" }, "question": { "$ref": "#/components/schemas/Question" }, "text_block": { "$ref": "#/components/schemas/Error#2" }, "type": { "example": "text", "type": "string" }, "unknown": { "example": "key", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey survey element", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/elements/{elem_id}/option_order": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-option_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey element option order", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-option_order", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "default": [1] }, "schema": { "properties": { "default": { "$ref": "#/components/schemas/Organizations" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Malformed data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey survey element option order", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/elements/{elem_id}/options": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-options", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey element option", "tags": ["Survey"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-options", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "My new option" }, "schema": { "properties": { "text": { "example": "My new option", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"unknown\" parameter is invalid. Wrong key 'unknown' in {'text': 'Option text', 'unknown': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post survey survey element option", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/elements/{elem_id}/options/{opt_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-options-{opt_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "opt_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete survey survey element option", "tags": ["Survey"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-options-{opt_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "opt_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey element option", "tags": ["Survey"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-surveys-{survey_id}-elements-{elem_id}-options-{opt_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "elem_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "opt_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "text": "New option text" }, "schema": { "properties": { "text": { "example": "New option text", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'invalid': 'value'}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch survey survey element option", "tags": ["Survey"] } }, "/orgs/{org_id}/surveys/{survey_id}/submissions": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-surveys-{survey_id}-submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get survey survey submission", "tags": ["Survey"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-surveys-{survey_id}-submissions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "survey_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "responses": [ { "options": [1], "question_id": 1 } ], "signature": null }, "schema": { "properties": { "responses": { "items": { "properties": { "options": { "$ref": "#/components/schemas/Organizations" }, "question_id": { "example": 1, "type": "integer" }, "response": { "example": "This is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long stringThis is a very long string", "type": "string" } }, "type": "object" }, "type": "array" }, "signature": { "anyOf": [ { "type": "null" }, { "example": "invalid", "type": "string" }, { "example": 1, "type": "integer" }, { "properties": { "email": { "example": "clara@zetk.in", "type": "string" }, "first_name": { "example": "Clara", "type": "string" }, "last_name": { "example": "Zetkin", "type": "string" } }, "type": "object" } ] } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": 1, "organization": { "id": 1, "title": "example_string" }, "respondent": null, "submitted": null, "survey": { "id": 1, "title": "Closed survey" } } }, "schema": { "properties": { "data": { "properties": { "id": { "example": 1, "type": "integer" }, "organization": { "$ref": "#/components/schemas/Organization" }, "respondent": { "type": "null" }, "submitted": { "type": "null" }, "survey": { "$ref": "#/components/schemas/Organization" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "Anonymous submission is not allowed", "title": "Missing signature" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "User not connected to organization" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post survey survey submission", "tags": ["Survey"] } }, "/orgs/{org_id}/tag_groups": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tag_groups", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "description": "", "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Member type" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get tag group", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-tag_groups", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "Dummy title" }, "schema": { "properties": { "title": { "example": "Dummy title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "description": "", "id": 1, "organization": { "id": 1, "title": "example_string" }, "title": "Dummy title" } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#3" } }, "type": "object" } } }, "description": "Example response for status 201" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"title\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post tag group", "tags": [] } }, "/orgs/{org_id}/tag_groups/{group_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-tag_groups-{group_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "group_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete tag group", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tag_groups-{group_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "group_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get tag group", "tags": [] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-tag_groups-{group_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "group_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "New title" }, "schema": { "properties": { "title": { "example": "New title", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n1 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n1 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch tag group", "tags": [] } }, "/orgs/{org_id}/tasks": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "campaign": { "id": 1, "title": "First campaign in 1" }, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "reassign_interval": null, "reassign_limit": null, "target": { "filter_spec": [ { "type": "all" } ], "id": 1 }, "time_estimate": null, "title": "Dummy task", "type": "offline" } ] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#10" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get task", "tags": ["Task"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-tasks", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n2 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n2 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post task", "tags": ["Task"] } }, "/orgs/{org_id}/tasks/{task_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--orgs-{org_id}-tasks-{task_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete task", "tags": ["Task"] }, "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks-{task_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get task", "tags": ["Task"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-tasks-{task_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "cover_file_id": null }, "schema": { "properties": { "cover_file_id": { "anyOf": [ { "type": "null" }, { "example": 1, "type": "integer" } ] } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"Key 'title' error:\n2 should be instance of 'str'\" parameter is invalid. Key 'title' error:\n2 should be instance of 'str'", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch task", "tags": ["Task"] } }, "/orgs/{org_id}/tasks/{task_id}/assigned": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks-{task_id}-assigned", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assigned": "1857-07-05T00:00:00.000000", "assignee": { "first_name": "Angela", "id": 1, "last_name": "Davis" }, "completed": null, "id": 1, "status": "overdue", "task": { "campaign": null, "config": {}, "cover_file": null, "deadline": "1857-07-05T00:00:00.000000", "expires": "1857-07-05T00:00:00.000000", "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "time_estimate": null, "title": "Dummy task", "type": "offline" } } ] }, "schema": { "properties": { "data": { "items": { "properties": { "assigned": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assignee": { "$ref": "#/components/schemas/Config" }, "completed": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "status": { "example": "assigned", "type": "string" }, "task": { "properties": { "campaign": { "type": "null" }, "config": { "$ref": "#/components/schemas/Bychangedfield" }, "cover_file": { "type": "null" }, "deadline": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "expires": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "id": { "example": 1, "type": "integer" }, "instructions": { "example": "Dummy task instructions", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "published": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "time_estimate": { "type": "null" }, "title": { "example": "Dummy task", "type": "string" }, "type": { "example": "offline", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get task assigned", "tags": ["Task"] } }, "/orgs/{org_id}/tasks/{task_id}/assigned/{person_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks-{task_id}-assigned-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "assigned": "1857-07-05T00:00:00.000000", "assignee": { "first_name": "Rosa", "id": 1, "last_name": "Luxemburg" }, "completed": "1857-07-05T00:00:00.000000", "id": 1, "status": "completed", "task": { "campaign": null, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "time_estimate": null, "title": "Dummy task", "type": "offline" } } ] }, "schema": { "properties": { "data": { "items": { "properties": { "assigned": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assignee": { "$ref": "#/components/schemas/Config" }, "completed": { "anyOf": [ { "type": "null" }, { "example": "1857-07-05T00:00:00.000000", "type": "string" } ] }, "id": { "example": 1, "type": "integer" }, "status": { "example": "assigned", "type": "string" }, "task": { "$ref": "#/components/schemas/Task" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get task assigned person", "tags": ["Task"] }, "post": { "deprecated": false, "description": "", "operationId": "post--orgs-{org_id}-tasks-{task_id}-assigned-{person_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "person_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "content": { "application/json": { "example": { "data": { "assigned": "1857-07-05T00:00:00.000000", "assignee": { "first_name": "Angela", "id": 1, "last_name": "Davis" }, "completed": null, "id": 1, "status": "assigned", "task": { "campaign": null, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "time_estimate": null, "title": "Dummy task", "type": "offline" } } }, "schema": { "properties": { "data": { "properties": { "assigned": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "assignee": { "$ref": "#/components/schemas/Config" }, "completed": { "type": "null" }, "id": { "example": 1, "type": "integer" }, "status": { "example": "assigned", "type": "string" }, "task": { "$ref": "#/components/schemas/Task" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 201" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Person is already assigned to task" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post task assigned person", "tags": ["Task"] } }, "/orgs/{org_id}/tasks/{task_id}/cover": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks-{task_id}-cover", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get task item cover", "tags": ["Task"] } }, "/orgs/{org_id}/tasks/{task_id}/target": { "get": { "deprecated": false, "description": "", "operationId": "get--orgs-{org_id}-tasks-{task_id}-target", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get task target", "tags": ["Task"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--orgs-{org_id}-tasks-{task_id}-target", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "task_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ] }, "schema": { "properties": { "filter_spec": { "$ref": "#/components/schemas/FilterSpec#7" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "filter_spec": [ { "config": {}, "op": "add", "type": "all" } ] } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Config#6" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"invalid\" parameter is invalid. Wrong key 'invalid' in {'filter_spec': [{'type': 'all', 'op': 'add', 'config': {}}], 'invalid': True}", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Patch task target", "tags": ["Task"] } }, "/password_reset_tokens": { "post": { "deprecated": false, "description": "", "operationId": "post--password_reset_tokens", "requestBody": { "content": { "application/json": { "example": { "email": "unknownemail@example.com" }, "schema": { "properties": { "email": { "example": "unknownemail@example.com", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "400": { "content": { "application/json": { "example": { "error": { "description": "The \"email\" parameter is required.", "title": "Missing parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "403": { "content": { "application/json": { "example": { "error": { "description": "Trying to reset your own password while authenticated", "title": "Already logged in" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post password token", "tags": ["Users"] } }, "/search/{data_type}": { "post": { "deprecated": false, "description": "", "operationId": "post--search-{data_type}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "user", "in": "path", "name": "data_type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "q": "willnotmatchanything" }, "schema": { "properties": { "q": { "example": "clara", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "properties": { "email": { "example": "testadmin@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Angela", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_verified": { "example": 1, "type": "integer" }, "joined": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "lang": { "type": "null" }, "last_login": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "last_name": { "example": "Davis", "type": "string" }, "phone": { "example": "+46701000002", "type": "string" }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Missing query" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post global search", "tags": ["Search"] } }, "/session": { "delete": { "deprecated": false, "description": "", "operationId": "delete--session", "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" } }, "summary": "Delete session", "tags": ["Users"] }, "get": { "deprecated": false, "description": "", "operationId": "get--session", "responses": { "200": { "content": { "application/json": { "example": { "data": { "created": "1857-07-05T00:00:00.000000", "factors": ["email_password"], "level": 1, "user": { "email": "testuser@example.com", "email_is_verified": 1, "first_name": "Jane", "id": 1, "is_verified": 1, "joined": "2026-06-03 08:46:55.596385+00:00", "lang": null, "last_login": "2026-06-03 08:46:55.596385+00:00", "last_name": "Doe", "phone": null, "phone_is_verified": 1 } } }, "schema": { "properties": { "data": { "properties": { "created": { "example": "1857-07-05T00:00:00.000000", "type": "string" }, "factors": { "$ref": "#/components/schemas/AllowedGrants" }, "level": { "example": 1, "type": "integer" }, "user": { "$ref": "#/components/schemas/User#2" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" } }, "summary": "Get session", "tags": ["Users"] } }, "/users": { "get": { "deprecated": false, "description": "", "operationId": "get--users", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "email": "testsuperuser@example.com", "email_is_verified": 1, "first_name": "Clara", "id": 1, "is_superuser": 1, "is_verified": 1, "joined": "2026-06-03 08:46:55.596385+00:00", "lang": null, "last_login": "2026-06-03 08:46:55.596385+00:00", "last_name": "Zetkin", "phone": "+00700000001", "phone_is_verified": 1 } ] }, "schema": { "properties": { "data": { "items": { "properties": { "email": { "example": "testsuperuser@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Clara", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_superuser": { "example": 1, "type": "integer" }, "is_verified": { "example": 1, "type": "integer" }, "joined": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "lang": { "type": "null" }, "last_login": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "last_name": { "example": "Zetkin", "type": "string" }, "phone": { "example": "+00700000001", "type": "string" }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid login method" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user", "tags": ["Users"] }, "post": { "deprecated": false, "description": "", "operationId": "post--users", "requestBody": { "content": { "application/json": { "example": { "first_name": "Clara", "last_name": "Zetkin", "phone": "+46701234567" }, "schema": { "properties": { "email": { "example": "example_string@example.com", "type": "string" }, "first_name": { "example": "Clara", "type": "string" }, "invite_code": { "example": "abc123", "type": "string" }, "lang": { "example": "de", "type": "string" }, "last_name": { "example": "Zetkin", "type": "string" }, "password": { "example": "password", "type": "string" }, "phone": { "example": "+46701234567", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "email": null, "email_is_verified": 1, "first_name": "Clara", "id": 1, "is_verified": 1, "joined": "2026-06-03 08:51:01.096136+00:00", "lang": null, "last_login": "2026-06-03 08:51:01.096132+00:00", "last_name": "Zetkin", "phone": "+46701234567", "phone_is_verified": 1 } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/User#2" } }, "type": "object" } } }, "description": "Example response for status 202" }, "400": { "content": { "application/json": { "example": { "error": { "description": "At least one must be included", "title": "Missing phone or e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "403": { "content": { "application/json": { "example": { "error": { "description": "Log out or authenticate as superuser.", "title": "Already authenticated" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "409": { "content": { "application/json": { "example": { "error": { "description": "duplicate_email", "title": "Email already exists" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Post user", "tags": ["Users"] } }, "/users/{user_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--users-{user_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete user", "tags": ["Users"] }, "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "email": "testuser@example.com", "email_is_verified": 1, "first_name": "Jane", "id": 1, "is_verified": 1, "joined": "2026-06-03 08:46:55.596385+00:00", "lang": null, "last_login": "2026-06-03 08:46:55.596385+00:00", "last_name": "Doe", "phone": null, "phone_is_verified": 1 } }, "schema": { "properties": { "data": { "properties": { "email": { "example": "testuser@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Jane", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_superuser": { "example": 1, "type": "integer" }, "is_verified": { "example": 1, "type": "integer" }, "joined": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "lang": { "type": "null" }, "last_login": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "last_name": { "example": "Doe", "type": "string" }, "phone": { "type": "null" }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user", "tags": ["Users"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--users-{user_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "first_name": "Newt", "lang": "en", "last_name": "Estuser" }, "schema": { "properties": { "email": { "example": "newtest@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Newt", "type": "string" }, "lang": { "example": "en", "type": "string" }, "last_name": { "example": "Estuser", "type": "string" }, "phone": { "anyOf": [ { "type": "null" }, { "example": "+46701234567", "type": "string" } ] }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "email": "testsuperuser@example.com", "email_is_verified": 1, "first_name": "Newt", "id": 1, "is_superuser": 1, "is_verified": 1, "joined": "2026-06-03 08:46:55.596385+00:00", "lang": "en", "last_login": "2026-06-03 08:46:55.596385+00:00", "last_name": "Estuser", "phone": "+00700000001", "phone_is_verified": 1 } }, "schema": { "properties": { "data": { "properties": { "email": { "example": "testuser@example.com", "type": "string" }, "email_is_verified": { "example": 1, "type": "integer" }, "first_name": { "example": "Newt", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_superuser": { "example": 1, "type": "integer" }, "is_verified": { "example": 1, "type": "integer" }, "joined": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "lang": { "example": "en", "type": "string" }, "last_login": { "example": "2026-06-03 08:46:55.596385+00:00", "type": "string" }, "last_name": { "example": "Estuser", "type": "string" }, "phone": { "anyOf": [ { "type": "null" }, { "example": "+46700000002", "type": "string" } ] }, "phone_is_verified": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Example response for status 200" }, "400": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Invalid data" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" }, "409": { "content": { "application/json": { "example": { "error": { "description": "", "title": "409 Conflict" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 409" } }, "summary": "Patch user", "tags": ["Users"] } }, "/users/{user_id}/action_responses": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-action_responses", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user action response", "tags": ["Campaign"] } }, "/users/{user_id}/actions": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-actions", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user action", "tags": ["Campaign"] } }, "/users/{user_id}/api_keys": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-api_keys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "client_id": "abc123", "grant": "abc123", "id": 1, "ip_whitelist": ["127.0.0.1"], "scope": ["abc123"] } ] }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Data#20" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user api key", "tags": [] }, "post": { "deprecated": false, "description": "", "operationId": "post--users-{user_id}-api_keys", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "client_id": "abc123", "client_secret": "abc123", "ip_whitelist": ["127.0.0.1"], "scope": ["abc123"] }, "schema": { "properties": { "client_id": { "example": "abc123", "type": "string" }, "client_secret": { "example": "abc123", "type": "string" }, "ip_whitelist": { "$ref": "#/components/schemas/AllowedGrants" }, "scope": { "$ref": "#/components/schemas/AllowedGrants" }, "unknown": { "example": "field", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "client_id": "abc123", "grant": "abc123", "id": 1, "ip_whitelist": ["127.0.0.1"], "scope": ["abc123"] } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#20" } }, "type": "object" } } }, "description": "Example response for status 201" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post user api key", "tags": [] } }, "/users/{user_id}/api_keys/{key_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--users-{user_id}-api_keys-{key_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "key_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Delete user api key", "tags": [] }, "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-api_keys-{key_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "key_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user api key", "tags": [] } }, "/users/{user_id}/assigned_tasks": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-assigned_tasks", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user assigned task", "tags": ["Task"] } }, "/users/{user_id}/assigned_tasks/{assigned_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-assigned_tasks-{assigned_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assigned_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "assigned": "1857-07-05T00:00:00.000000", "assignee": { "first_name": "Dummy", "id": 1, "last_name": "User" }, "completed": "1857-07-05T00:00:00.000000", "id": 1, "status": "completed", "task": { "campaign": null, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "time_estimate": null, "title": "Dummy task", "type": "offline" } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#21" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user assigned task", "tags": ["Task"] }, "patch": { "deprecated": false, "description": "", "operationId": "patch--users-{user_id}-assigned_tasks-{assigned_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "assigned_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "completed" }, "schema": { "properties": { "invalid": { "example": 1, "type": "integer" }, "status": { "example": "completed", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "assigned": "1857-07-05T00:00:00.000000", "assignee": { "first_name": "Dummy", "id": 1, "last_name": "User" }, "completed": "1857-07-05T00:00:00.000000", "id": 1, "status": "completed", "task": { "campaign": null, "config": {}, "cover_file": null, "deadline": null, "expires": null, "id": 1, "instructions": "Dummy task instructions", "organization": { "id": 1, "title": "example_string" }, "published": "1857-07-05T00:00:00.000000", "time_estimate": null, "title": "Dummy task", "type": "offline" } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#21" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Patch user assigned task", "tags": ["Task"] } }, "/users/{user_id}/avatar": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-avatar", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "303": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 303" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user avatar", "tags": ["Users"] } }, "/users/{user_id}/call_assignments": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-call_assignments", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user call assignment", "tags": ["Call"] } }, "/users/{user_id}/following": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-following", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#22" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user following", "tags": ["Organizations"] } }, "/users/{user_id}/following/{org_id}": { "delete": { "deprecated": false, "description": "", "operationId": "delete--users-{user_id}-following-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Delete user following", "tags": ["Organizations"] }, "put": { "deprecated": false, "description": "", "operationId": "put--users-{user_id}-following-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Put user following", "tags": ["Organizations"] } }, "/users/{user_id}/invites": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-invites", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user invite", "tags": ["Organizations"] } }, "/users/{user_id}/memberships": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-memberships", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/Data#22" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user membership", "tags": ["Organizations"] } }, "/users/{user_id}/memberships/{org_id}": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-memberships-{org_id}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "org_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user membership", "tags": ["Organizations"] } }, "/users/{user_id}/outgoing_calls": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-outgoing_calls", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/FilterSpec" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user call", "tags": ["Call"] } }, "/users/{user_id}/password": { "post": { "deprecated": false, "description": "", "operationId": "post--users-{user_id}-password", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "my_password": "password", "new_password": "example_string" }, "schema": { "properties": { "my_password": { "example": "password", "type": "string" }, "new_password": { "example": "example_string", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "content": { "application/json": { "example": "", "schema": { "example": "", "type": "string" } } }, "description": "Example response for status 204" }, "400": { "content": { "application/json": { "example": { "error": { "description": "The \"reset_code\" parameter is invalid. The reset code was incorrect", "title": "Invalid parameter" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 400" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "E-mail not verified" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Post user password", "tags": ["Users"] } }, "/users/{user_id}/profiles": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-profiles", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [] }, "schema": { "properties": { "data": { "items": { "properties": { "alt_phone": { "type": "null" }, "city": { "type": "null" }, "co_address": { "type": "null" }, "country": { "type": "null" }, "email": { "example": "testadmin@example.com", "type": "string" }, "ext_id": { "type": "null" }, "first_name": { "example": "Angela", "type": "string" }, "gender": { "example": "f", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_user": { "example": 1, "type": "integer" }, "last_name": { "example": "Davis", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "phone": { "example": "+4675463729", "type": "string" }, "street_address": { "type": "null" }, "zip_code": { "type": "null" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" } }, "summary": "Get user profile", "tags": ["Organizations"] } }, "/users/{user_id}/recommended_organizations": { "get": { "deprecated": false, "description": "", "operationId": "get--users-{user_id}-recommended_organizations", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "country": "SE", "id": 1, "is_open": 1, "location": null, "parent_id": 1, "short_title": null, "slug": "myotherorg", "title": "My Other Organization" } ] }, "schema": { "properties": { "data": { "items": { "properties": { "country": { "example": "SE", "type": "string" }, "id": { "example": 1, "type": "integer" }, "is_open": { "example": 1, "type": "integer" }, "location": { "type": "null" }, "parent_id": { "example": 1, "type": "integer" }, "short_title": { "type": "null" }, "slug": { "example": "myotherorg", "type": "string" }, "title": { "example": "My Other Organization", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Example response for status 200" }, "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "Unverified e-mail" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Get user recommended organization", "tags": ["Organizations"] } }, "/users/{user_id}/verification_codes": { "post": { "deprecated": false, "description": "", "operationId": "post--users-{user_id}-verification_codes", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "me", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Post user verification code", "tags": ["Users"] } }, "/users/{user_id}/verification_codes/{code}": { "put": { "deprecated": false, "description": "", "operationId": "put--users-{user_id}-verification_codes-{code}", "parameters": [ { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": 1, "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } }, { "allowEmptyValue": false, "allowReserved": false, "deprecated": false, "example": "abc123", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "example": { "error": { "description": "", "title": "401 Unauthorized" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 401" }, "403": { "content": { "application/json": { "example": { "error": { "description": "", "title": "403 Forbidden" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error#2" } }, "type": "object" } } }, "description": "Example response for status 403" }, "404": { "content": { "application/json": { "example": { "error": { "title": "404 Not Found" } }, "schema": { "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "type": "object" } } }, "description": "Example response for status 404" } }, "summary": "Put user verification code", "tags": ["Users"] } } }, "servers": [ { "description": "Gen 3 Next.js API Proxy to Core 1", "url": "https://app.dev.zetkin.org/api" }, { "description": "Backend Core 1 API", "url": "https://api.dev.zetkin.org/v1" } ] }