{ "openapi": "3.0.1", "servers": [ { "url": "https://{domain}/api", "variables": { "domain": { "description": "domain assigned by Loxo" } } } ], "security": [ { "loxo_bearer_token": [] } ], "info": { "title": "Loxo API", "description": "API for the Loxo application", "version": "1.3.1" }, "components": { "schemas": {}, "securitySchemes": { "loxo_bearer_token": { "type": "http", "scheme": "bearer" } } }, "paths": { "/{agency_slug}/activity_types": { "get": { "operationId": "activity_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Unique identifier", "name": "workflow_id", "in": "query", "schema": { "type": "integer" } }, { "name": "show_hidden", "in": "query", "schema": { "type": "boolean" } } ] } }, "/{agency_slug}/address_types": { "get": { "operationId": "address_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/bonus_payment_types": { "get": { "operationId": "bonus_payment_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/bonus_types": { "get": { "operationId": "bonus_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/companies": { "post": { "operationId": "companies:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "company[name]": { "type": "string" }, "company[url]": { "type": "string" }, "company[description]": { "type": "string" }, "company[culture]": { "type": "string" }, "company[blocked]": { "type": "boolean" }, "company[blocked_until]": { "type": "string", "format": "date-time" }, "company[fee]": { "type": "number", "format": "float" }, "company[fee_type_id]": { "type": "integer" }, "company[company_type_id]": { "type": "integer" }, "company[owner_email]": { "type": "string" }, "company[company_global_status_id]": { "type": "integer" }, "company[emails][]": { "type": "string" }, "company[phones][]": { "type": "string" }, "company[addresses][]": { "type": "object", "properties": { "_destroy": { "type": "boolean", "description": "Pass true here to destroy the address by id" }, "id": { "description": "Unique identifier", "type": "integer" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" }, "city": { "type": "string" }, "state_code": { "description": "2 character identifier for the state", "type": "string" }, "zip": { "description": "Zip code or postal code", "type": "string" }, "country_code": { "description": "2 character identifier for the country", "type": "string" } } }, "company[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "company[$hierarchy_dynamic_field_key][]": { "type": "string" } }, "required": [ "name" ] } } } } }, "get": { "operationId": "companies:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "company_type_id", "in": "query", "schema": { "type": "integer" } }, { "name": "list_id", "in": "query", "schema": { "type": "integer" } }, { "name": "company_global_status_id", "in": "query", "schema": { "type": "integer" } }, { "name": "fields", "in": "query", "schema": { "type": "object" } } ] } }, "/{agency_slug}/companies/{company_id}/addresses": { "get": { "operationId": "company_addresses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "post": { "operationId": "company_addresses:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "address_type_id": { "type": "integer" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" }, "city": { "type": "string" }, "state_id": { "type": "integer" }, "zip": { "type": "string" }, "country_id": { "type": "integer" }, "position": { "type": "integer" } } } } } } } }, "/{agency_slug}/companies/{company_id}/addresses/{id}": { "get": { "operationId": "company_addresses:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "delete": { "operationId": "company_addresses:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "company_addresses:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "address_type_id": { "type": "integer" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" }, "city": { "type": "string" }, "state_id": { "type": "integer" }, "zip": { "type": "string" }, "country_id": { "type": "integer" }, "position": { "type": "integer" } } } } } } } }, "/{agency_slug}/companies/{company_id}/documents": { "post": { "operationId": "company_documents:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "binary" } } } } } } } }, "/{agency_slug}/companies/{company_id}/documents/{company_document_id}/download": { "get": { "operationId": "company_documents:download", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "company_document_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/companies/{company_id}/documents/{id}": { "delete": { "operationId": "company_documents:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/companies/{company_id}/emails": { "post": { "operationId": "company_emails:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "email_type_id": { "type": "integer" }, "sync": { "type": "boolean" }, "position": { "type": "integer" } } } } } } }, "get": { "operationId": "company_emails:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/companies/{company_id}/emails/{id}": { "get": { "operationId": "company_emails:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "delete": { "operationId": "company_emails:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "company_emails:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "email_type_id": { "type": "integer" }, "sync": { "type": "boolean" }, "position": { "type": "integer" } } } } } } } }, "/{agency_slug}/companies/{company_id}/people": { "get": { "operationId": "company_people:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } } ] } }, "/{agency_slug}/companies/{company_id}/phones": { "post": { "operationId": "company_phones:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "phone_type_id": { "type": "integer" }, "position": { "type": "integer" } } } } } } }, "get": { "operationId": "company_phones:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/companies/{company_id}/phones/{id}": { "delete": { "operationId": "company_phones:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "company_phones:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "company_phones:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "company_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "phone_type_id": { "type": "integer" }, "position": { "type": "integer" } } } } } } } }, "/{agency_slug}/companies/{id}": { "put": { "operationId": "companies:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "company[name]": { "type": "string" }, "company[url]": { "type": "string" }, "company[description]": { "type": "string" }, "company[culture]": { "type": "string" }, "company[blocked]": { "type": "boolean" }, "company[blocked_until]": { "type": "string", "format": "date-time" }, "company[fee]": { "type": "number", "format": "float" }, "company[fee_type_id]": { "type": "integer" }, "company[company_type_id]": { "type": "integer" }, "company[owner_email]": { "type": "string" }, "company[company_global_status_id]": { "type": "integer" }, "company[emails][]": { "type": "string" }, "company[phones][]": { "type": "string" }, "company[addresses][]": { "type": "object", "properties": { "_destroy": { "type": "boolean", "description": "Pass true here to destroy the address by id" }, "id": { "description": "Unique identifier", "type": "integer" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" }, "city": { "type": "string" }, "state_code": { "description": "2 character identifier for the state", "type": "string" }, "zip": { "description": "Zip code or postal code", "type": "string" }, "country_code": { "description": "2 character identifier for the country", "type": "string" } } }, "company[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "company[$hierarchy_dynamic_field_key][]": { "type": "string" } }, "required": [ "name" ] } } } } }, "get": { "operationId": "companies:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/company_global_statuses": { "get": { "operationId": "company_global_statuses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/company_types": { "get": { "operationId": "company_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/compensation_types": { "get": { "operationId": "compensation_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/countries": { "get": { "operationId": "countries:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Page number to return. Starting at 1", "name": "page", "in": "query", "schema": { "type": "integer" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } } ] } }, "/{agency_slug}/countries/{country_id}/states": { "get": { "operationId": "states:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "country_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "description": "Page number to return. Starting at 1", "name": "page", "in": "query", "schema": { "type": "integer" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "description": "Unique identifier", "name": "country_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/countries/{country_id}/states/{state_id}/cities": { "get": { "operationId": "cities:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "country_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "state_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Unique identifier", "name": "country_id", "in": "query", "schema": { "type": "integer" } }, { "description": "Unique identifier", "name": "state_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/currencies": { "get": { "operationId": "currencies:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/deal_workflows": { "get": { "operationId": "deal_workflows:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/deal_workflows/{id}": { "get": { "operationId": "deal_workflows:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/deals": { "get": { "operationId": "deals:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "owner_emails[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ] }, "post": { "operationId": "deals:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "deal[name]": { "type": "string" }, "deal[amount]": { "type": "number", "format": "float" }, "deal[closes_at]": { "type": "string", "format": "datetime" }, "deal[company_id]": { "type": "integer" }, "deal[person_id]": { "type": "integer" }, "deal[job_id]": { "type": "integer" }, "deal[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "deal[$hierarchy_dynamic_field_key][]": { "type": "string" }, "deal[workflow_id]": { "type": "integer" }, "deal[pipeline_stage_id]": { "type": "integer" }, "deal[owner_email]": { "type": "string" } }, "required": [ "name", "amount", "closes_at", "workflow_id", "pipeline_stage_id", "owner_email" ] } } } } } }, "/{agency_slug}/deals/{deal_id}/events": { "post": { "operationId": "deal_events:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "deal_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "activity_type_id": { "type": "number" }, "notes": { "type": "string" }, "dragged_and_dropped": { "type": "boolean" } }, "required": [ "activity_type_id" ] } } } } } }, "/{agency_slug}/deals/{id}": { "get": { "operationId": "deals:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/disability_statuses": { "get": { "operationId": "disability_statuses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/diversity_types": { "get": { "operationId": "diversity_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/dynamic_fields": { "get": { "operationId": "dynamic_fields:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/dynamic_fields/{dynamic_field_id}/hierarchies": { "post": { "operationId": "hierarchies:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dynamic_field_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "integer" }, "dynamic_field_id": { "type": "integer" } }, "required": [ "name", "dynamic_field_id" ] } } } } }, "get": { "operationId": "hierarchies:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dynamic_field_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/dynamic_fields/{dynamic_field_id}/hierarchies/{id}": { "delete": { "operationId": "hierarchies:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dynamic_field_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "hierarchies:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dynamic_field_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "integer" } }, "required": [ "name" ] } } } } }, "get": { "operationId": "hierarchies:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "dynamic_field_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/dynamic_fields/{id}": { "get": { "operationId": "dynamic_fields:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/education_types": { "get": { "operationId": "education_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/email_tracking": { "get": { "operationId": "email_tracking:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "ID of the person receiving the emails", "name": "person_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "created_at_start", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "created_at_end", "in": "query", "schema": { "type": "string", "format": "datetime" } } ] } }, "/{agency_slug}/email_types": { "get": { "operationId": "email_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/equity_types": { "get": { "operationId": "equity_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/ethnicities": { "get": { "operationId": "ethnicities:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/fee_types": { "get": { "operationId": "fee_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/form_templates": { "get": { "operationId": "form_templates:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/form_templates/{id}": { "get": { "operationId": "form_templates:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/forms": { "post": { "operationId": "forms:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "company_id": { "type": "integer" }, "job_id": { "type": "integer" }, "person_id": { "type": "integer" }, "title": { "type": "string" }, "form_template_id": { "type": "integer" } }, "required": [ "form_template_id" ] } } } } }, "get": { "operationId": "forms:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "schema": { "type": "integer" } }, { "name": "job_id", "in": "query", "schema": { "type": "integer" } }, { "name": "person_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/forms/{id}": { "delete": { "operationId": "forms:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "forms:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "company_id": { "type": "integer" }, "job_id": { "type": "integer" }, "person_id": { "type": "integer" }, "title": { "type": "string" }, "form_template_id": { "type": "integer" } }, "required": [ "id", "form_template_id" ] } } } } }, "get": { "operationId": "forms:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/genders": { "get": { "operationId": "genders:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_categories": { "get": { "operationId": "job_categories:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_contact_types": { "get": { "operationId": "job_contact_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_listing_config": { "get": { "operationId": "job_listing_config:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_owner_types": { "get": { "operationId": "job_owner_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_statuses": { "get": { "operationId": "job_statuses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/job_types": { "get": { "operationId": "job_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/jobs": { "post": { "operationId": "jobs:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "job[active]": { "type": "boolean" }, "job[address]": { "type": "string" }, "job[city]": { "type": "string" }, "job[company_hidden]": { "type": "boolean" }, "job[company_id]": { "type": "integer" }, "job[country_id]": { "type": "string" }, "job[description]": { "type": "string" }, "job[internal_notes]": { "type": "string" }, "job[job_category_ids][]": { "type": "integer" }, "job[job_status_id]": { "type": "integer" }, "job[job_type_id]": { "type": "integer" }, "job[owner_emails][]": { "type": "string" }, "job[published]": { "type": "boolean" }, "job[published_at]": { "type": "string", "format": "date-time" }, "job[raw_company_name]": { "type": "string" }, "job[salary]": { "type": "string" }, "job[state_id]": { "type": "string" }, "job[title]": { "description": "Title of the job", "type": "string" }, "job[published_name]": { "description": "Public title of the job, will use title if not specified", "type": "string" }, "job[zip]": { "type": "string" }, "job[published_end_date]": { "type": "string", "format": "date-time" }, "job[remote_work_allowed]": { "type": "boolean" }, "job[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "job[$hierarchy_dynamic_field_key][]": { "type": "string" } }, "required": [ "job_type_id", "raw_company_name", "title" ] } } } } }, "get": { "operationId": "jobs:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Page number to return. Starting at 1", "name": "page", "in": "query", "schema": { "type": "integer" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "description": "Include results from related agencies", "name": "include_related_agencies", "in": "query", "schema": { "type": "boolean" } }, { "description": "Sort by published_at", "name": "published_at_sort", "in": "query", "schema": { "type": "string" } }, { "description": "Sort by rank", "name": "rank_sort", "in": "query", "schema": { "type": "string" } }, { "description": "Sort by updated_at", "name": "updated_at_sort", "in": "query", "schema": { "type": "string" } }, { "description": "Sort by location", "name": "location_sort", "in": "query", "schema": { "type": "string" } }, { "description": "Sort by title", "name": "job_title_sort", "in": "query", "schema": { "type": "string" } }, { "name": "published", "in": "query", "schema": { "type": "boolean" } }, { "name": "job_status_id", "in": "query", "schema": { "type": "integer" } }, { "name": "job_status_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "job_type_id", "in": "query", "schema": { "type": "integer" } }, { "name": "country_id", "in": "query", "schema": { "type": "integer" } }, { "name": "state_id", "in": "query", "schema": { "type": "integer" } }, { "name": "city", "in": "query", "schema": { "type": "string" } }, { "description": "ID of the job category (aka job tag)", "name": "job_category_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "description": "ID of the job owner", "name": "owned_by_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "job_type", "in": "query", "schema": { "type": "string" } }, { "name": "remote_work_allowed", "in": "query", "schema": { "type": "boolean" } }, { "name": "serialization_set", "in": "query", "schema": { "type": "string" } } ] } }, "/{agency_slug}/jobs/{id}": { "put": { "operationId": "jobs:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "job[active]": { "type": "boolean" }, "job[address]": { "type": "string" }, "job[city]": { "type": "string" }, "job[company_hidden]": { "type": "boolean" }, "job[company_id]": { "type": "integer" }, "job[country_id]": { "type": "string" }, "job[description]": { "type": "string" }, "job[internal_notes]": { "type": "string" }, "job[job_category_ids][]": { "type": "integer" }, "job[job_status_id]": { "type": "integer" }, "job[job_type_id]": { "type": "integer" }, "job[owner_emails][]": { "type": "string" }, "job[published]": { "type": "boolean" }, "job[published_at]": { "type": "string", "format": "date-time" }, "job[raw_company_name]": { "type": "string" }, "job[salary]": { "type": "string" }, "job[state_id]": { "type": "string" }, "job[title]": { "description": "Title of the job", "type": "string" }, "job[published_name]": { "description": "Public title of the job, will use title if not specified", "type": "string" }, "job[zip]": { "type": "string" }, "job[published_end_date]": { "type": "string", "format": "date-time" }, "job[remote_work_allowed]": { "type": "boolean" }, "job[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "job[$hierarchy_dynamic_field_key][]": { "type": "string" } }, "required": [ "job_type_id", "raw_company_name", "title" ] } } } } }, "delete": { "operationId": "jobs:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "jobs:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/jobs/{job_id}/apply": { "post": { "operationId": "jobs:apply", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email of applying candidate. Will lookup existing people" }, "name": { "type": "string", "description": "Name of applying candidate" }, "phone": { "type": "string", "description": "Phone number of applying candidate" }, "linkedin": { "type": "string", "description": "LinkedIn profile URL of applying candidate" }, "resume": { "type": "string", "format": "binary", "description": "Resume of applying candidate" }, "work_authorization": { "type": "boolean" }, "requires_visa": { "type": "boolean" }, "gender_ids[]": { "type": "integer" }, "ethnicity_ids[]": { "type": "integer" }, "veteran_status_id": { "type": "integer" }, "pronoun_id": { "type": "integer" }, "other_pronoun": { "type": "string" }, "disability_status_id": { "type": "integer" }, "form_template_id": { "type": "integer" }, "source_type_id": { "type": "integer" } }, "required": [ "email", "name", "phone" ] } } } } } }, "/{agency_slug}/jobs/{job_id}/candidates": { "get": { "operationId": "candidates:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "activity_type_id", "in": "query", "schema": { "type": "integer" } }, { "name": "person_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/jobs/{job_id}/candidates/{id}": { "get": { "operationId": "candidates:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "job_id", "in": "query", "schema": { "type": "integer" } }, { "name": "id", "in": "query", "schema": { "type": "integer" } } ] }, "put": { "operationId": "candidates:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "highlights": { "type": "string" } } } } } } } }, "/{agency_slug}/jobs/{job_id}/contacts": { "get": { "operationId": "job_contacts:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "post": { "operationId": "job_contacts:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "person_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" }, "job_contact_type_id": { "description": "Unique identifier", "type": "integer" } } } } } } } }, "/{agency_slug}/jobs/{job_id}/contacts/{id}": { "delete": { "operationId": "job_contacts:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "job_contacts:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "person_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" }, "job_contact_type_id": { "description": "Unique identifier", "type": "integer" } } } } } } } }, "/{agency_slug}/jobs/{job_id}/documents": { "post": { "operationId": "job_documents:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "binary" } } } } } } } }, "/{agency_slug}/jobs/{job_id}/documents/{id}": { "delete": { "operationId": "job_documents:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/jobs/{job_id}/documents/{job_document_id}/download": { "get": { "operationId": "job_documents:download", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "job_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "job_document_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/merges": { "get": { "operationId": "merges:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "item_type", "in": "query", "schema": { "type": "string" } }, { "name": "item_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "description": "Timestamp before which the merge was created", "name": "created_before", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "description": "Timestamp after which the merge was created", "name": "created_after", "in": "query", "schema": { "type": "string", "format": "datetime" } } ] } }, "/{agency_slug}/people": { "post": { "operationId": "people:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person[profile_picture]": { "type": "string", "format": "binary", "description": "Profile picture of the person" }, "person[name]": { "type": "string" }, "person[description]": { "type": "string" }, "person[location]": { "type": "string" }, "person[address]": { "type": "string" }, "person[city]": { "type": "string" }, "person[state]": { "type": "string" }, "person[zip]": { "type": "string" }, "person[country]": { "type": "string" }, "person[person_global_status_id]": { "description": "Unique identifier", "type": "integer" }, "person[source_type_id]": { "type": "integer" }, "person[blocked]": { "type": "boolean", "description": "Indicates whether the current person is blocked" }, "person[blocked_until]": { "type": "string", "format": "datetime", "description": "Timestamp after which the current person will no longer be blocked" }, "person[title]": { "type": "string", "description": "The title of their current job" }, "person[company]": { "type": "string", "description": "The name of the company they currently work at" }, "person[email]": { "type": "string", "description": "Their email address" }, "person[emails][]": { "type": "object", "properties": { "value": { "type": "string" }, "email_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[phone]": { "type": "string", "description": "Their phone number" }, "person[phones][]": { "type": "object", "properties": { "value": { "type": "string" }, "phone_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[data_sources][]": { "type": "object", "properties": { "source_id": { "type": "string" }, "source_type_id": { "description": "Unique identifier", "type": "integer" } } }, "person[linkedin_url]": { "type": "string", "description": "The URL of their linkedin profile" }, "person[website]": { "type": "string", "description": "The URL of their website" }, "person[resume]": { "type": "string", "format": "binary", "description": "Their resume file" }, "person[document]": { "type": "string", "format": "binary", "description": "Other documents associated to this person" }, "person[all_raw_tags][]": { "type": "string" }, "person[person_type_id]": { "type": "integer" }, "person[candidates][]": { "type": "object", "properties": { "job_id": { "type": "integer" }, "activity_type_id": { "type": "integer", "description": "ID of pipeline stage that the candidate should be added to, defaults to \"applied\" stage" } } }, "person[list_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[diversity_type_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[compensation]": { "type": "number", "format": "float" }, "person[compensation_notes]": { "type": "string" }, "person[salary]": { "type": "number", "format": "float" }, "person[salary_type_id]": { "type": "integer" }, "person[compensation_currency_id]": { "type": "integer" }, "person[owned_by_id]": { "type": "integer" }, "person[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "person[$hierarchy_dynamic_field_key][]": { "type": "string" } }, "required": [ "profile_picture", "name" ] } } } } }, "get": { "operationId": "people:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "description": "Include results from related agencies", "name": "include_related_agencies", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "exclude_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "person_global_status_id", "in": "query", "schema": { "type": "integer" } }, { "name": "active_job_stage_id", "in": "query", "schema": { "type": "integer" } }, { "name": "active_workflow_stage_id", "in": "query", "schema": { "type": "integer" } }, { "name": "person_type_id", "in": "query", "schema": { "type": "integer" } }, { "name": "list_id", "in": "query", "schema": { "type": "integer" } }, { "name": "created_at_sort", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at_sort", "in": "query", "schema": { "type": "string" } }, { "name": "serialization_set", "in": "query", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "schema": { "type": "object" } } ] } }, "/{agency_slug}/people/{id}": { "get": { "operationId": "people:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "people:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person[profile_picture]": { "type": "string", "format": "binary", "description": "Profile picture of the person" }, "person[name]": { "type": "string" }, "person[description]": { "type": "string" }, "person[location]": { "type": "string" }, "person[address]": { "type": "string" }, "person[city]": { "type": "string" }, "person[state]": { "type": "string" }, "person[zip]": { "type": "string" }, "person[country]": { "type": "string" }, "person[person_global_status_id]": { "description": "Unique identifier", "type": "integer" }, "person[source_type_id]": { "type": "integer" }, "person[blocked]": { "type": "boolean", "description": "Indicates whether the current person is blocked" }, "person[blocked_until]": { "type": "string", "format": "datetime", "description": "Timestamp after which the current person will no longer be blocked" }, "person[title]": { "type": "string", "description": "The title of their current job" }, "person[company]": { "type": "string", "description": "The name of the company they currently work at" }, "person[email]": { "type": "string", "description": "Their email address" }, "person[emails][]": { "type": "object", "properties": { "value": { "type": "string" }, "email_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[phone]": { "type": "string", "description": "Their phone number" }, "person[phones][]": { "type": "object", "properties": { "value": { "type": "string" }, "phone_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[data_sources][]": { "type": "object", "properties": { "source_id": { "type": "string" }, "source_type_id": { "description": "Unique identifier", "type": "integer" } } }, "person[linkedin_url]": { "type": "string", "description": "The URL of their linkedin profile" }, "person[website]": { "type": "string", "description": "The URL of their website" }, "person[resume]": { "type": "string", "format": "binary", "description": "Their resume file" }, "person[document]": { "type": "string", "format": "binary", "description": "Other documents associated to this person" }, "person[all_raw_tags][]": { "type": "string" }, "person[person_type_id]": { "type": "integer" }, "person[candidates][]": { "type": "object", "properties": { "job_id": { "type": "integer" }, "activity_type_id": { "type": "integer", "description": "ID of pipeline stage that the candidate should be added to, defaults to \"applied\" stage" } } }, "person[list_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[diversity_type_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[compensation]": { "type": "number", "format": "float" }, "person[compensation_notes]": { "type": "string" }, "person[salary]": { "type": "number", "format": "float" }, "person[salary_type_id]": { "type": "integer" }, "person[compensation_currency_id]": { "type": "integer" }, "person[owned_by_id]": { "type": "integer" }, "person[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "person[$hierarchy_dynamic_field_key][]": { "type": "string" }, "person[raw_tags][]": { "type": "string" } }, "required": [ "profile_picture" ] } } } } } }, "/{agency_slug}/people/{person_id}/documents": { "post": { "operationId": "person_documents:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "binary" } } } } } } } }, "/{agency_slug}/people/{person_id}/documents/{id}": { "delete": { "operationId": "person_documents:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/documents/{person_document_id}/download": { "get": { "operationId": "person_documents:download", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "person_document_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/education_profiles": { "post": { "operationId": "person_education_profiles:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "degree": { "type": "string" }, "school": { "type": "string" }, "month": { "type": "integer" }, "year": { "type": "integer" }, "education_type_id": { "type": "integer" }, "description": { "type": "string" } } } } } } }, "get": { "operationId": "person_education_profiles:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/education_profiles/{id}": { "put": { "operationId": "person_education_profiles:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "degree": { "type": "string" }, "school": { "type": "string" }, "month": { "type": "integer" }, "year": { "type": "integer" }, "education_type_id": { "type": "integer" }, "description": { "type": "string" } } } } } } }, "delete": { "operationId": "person_education_profiles:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "person_education_profiles:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/emails": { "post": { "operationId": "person_emails:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_email[value]": { "type": "string" }, "person_email[email_type_id]": { "type": "integer" }, "person_email[sync]": { "type": "boolean" }, "person_email[position]": { "type": "integer" } } } } } } }, "get": { "operationId": "person_emails:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/emails/{id}": { "delete": { "operationId": "person_emails:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "person_emails:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "person_emails:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_email[value]": { "type": "string" }, "person_email[email_type_id]": { "type": "integer" }, "person_email[sync]": { "type": "boolean" }, "person_email[position]": { "type": "integer" } } } } } } } }, "/{agency_slug}/people/{person_id}/job_profiles": { "post": { "operationId": "person_job_profiles:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "company_name": { "type": "string" }, "company_id": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" }, "end_month": { "type": "integer" }, "end_year": { "type": "integer" }, "current": { "type": "boolean" } } } } } } }, "get": { "operationId": "person_job_profiles:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/job_profiles/{id}": { "put": { "operationId": "person_job_profiles:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "company_name": { "type": "string" }, "company_id": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" }, "end_month": { "type": "integer" }, "end_year": { "type": "integer" }, "current": { "type": "boolean" } } } } } } }, "get": { "operationId": "person_job_profiles:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "delete": { "operationId": "person_job_profiles:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/list_items": { "get": { "operationId": "person_list_items:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "post": { "operationId": "person_list_items:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_list_item[person_list_id]": { "type": "integer" }, "person_list_item[position]": { "type": "integer" } } } } } } } }, "/{agency_slug}/people/{person_id}/list_items/{id}": { "delete": { "operationId": "person_list_items:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "person_list_items:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "person_list_items:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_list_item[person_list_id]": { "type": "integer" }, "person_list_item[position]": { "type": "integer" } } } } } } } }, "/{agency_slug}/people/{person_id}/phones": { "post": { "operationId": "person_phones:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_phone[value]": { "type": "string" }, "person_phone[phone_type_id]": { "type": "integer" }, "person_phone[position]": { "type": "integer" } } } } } } }, "get": { "operationId": "person_phones:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/phones/{id}": { "get": { "operationId": "person_phones:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "person_phones:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_phone[value]": { "type": "string" }, "person_phone[phone_type_id]": { "type": "integer" }, "person_phone[position]": { "type": "integer" } } } } } } }, "delete": { "operationId": "person_phones:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/resumes": { "post": { "operationId": "resumes:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "binary" }, "source_type_id": { "type": "integer" } } } } } } } }, "/{agency_slug}/people/{person_id}/resumes/{id}": { "delete": { "operationId": "resumes:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/resumes/{resume_id}/download": { "get": { "operationId": "resumes:download", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "resume_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/share": { "post": { "operationId": "people:share", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "job_id": { "description": "Unique identifier", "type": "integer" }, "user_id": { "description": "Unique identifier", "type": "integer" }, "field_type_keys[]": { "type": "string" }, "expires_in_days": { "type": "integer" } } } } } } } }, "/{agency_slug}/people/{person_id}/sms_opt_ins": { "post": { "operationId": "person_sms_opt_ins:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "opt_in": { "type": "boolean" }, "normalized_phone_number": { "type": "string" } } } } } } }, "get": { "operationId": "person_sms_opt_ins:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/sms_opt_ins/{id}": { "get": { "operationId": "person_sms_opt_ins:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/social_profiles": { "post": { "operationId": "person_social_profiles:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "social_profile_type_id": { "type": "integer" }, "url": { "type": "string" } } } } } } }, "get": { "operationId": "person_social_profiles:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/{person_id}/social_profiles/{id}": { "put": { "operationId": "person_social_profiles:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "social_profile_type_id": { "type": "integer" }, "url": { "type": "string" } } } } } } }, "get": { "operationId": "person_social_profiles:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "delete": { "operationId": "person_social_profiles:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/people/update_by_email": { "post": { "operationId": "people:update_by_email", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person[profile_picture]": { "type": "string", "format": "binary", "description": "Profile picture of the person" }, "person[name]": { "type": "string" }, "person[description]": { "type": "string" }, "person[location]": { "type": "string" }, "person[address]": { "type": "string" }, "person[city]": { "type": "string" }, "person[state]": { "type": "string" }, "person[zip]": { "type": "string" }, "person[country]": { "type": "string" }, "person[person_global_status_id]": { "description": "Unique identifier", "type": "integer" }, "person[source_type_id]": { "type": "integer" }, "person[blocked]": { "type": "boolean", "description": "Indicates whether the current person is blocked" }, "person[blocked_until]": { "type": "string", "format": "datetime", "description": "Timestamp after which the current person will no longer be blocked" }, "person[title]": { "type": "string", "description": "The title of their current job" }, "person[company]": { "type": "string", "description": "The name of the company they currently work at" }, "person[email]": { "type": "string", "description": "Their email address" }, "person[emails][]": { "type": "object", "properties": { "value": { "type": "string" }, "email_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[phone]": { "type": "string", "description": "Their phone number" }, "person[phones][]": { "type": "object", "properties": { "value": { "type": "string" }, "phone_type_id": { "description": "Unique identifier", "type": "integer" }, "position": { "type": "integer" } } }, "person[data_sources][]": { "type": "object", "properties": { "source_id": { "type": "string" }, "source_type_id": { "description": "Unique identifier", "type": "integer" } } }, "person[linkedin_url]": { "type": "string", "description": "The URL of their linkedin profile" }, "person[website]": { "type": "string", "description": "The URL of their website" }, "person[resume]": { "type": "string", "format": "binary", "description": "Their resume file" }, "person[document]": { "type": "string", "format": "binary", "description": "Other documents associated to this person" }, "person[all_raw_tags][]": { "type": "string" }, "person[person_type_id]": { "type": "integer" }, "person[candidates][]": { "type": "object", "properties": { "job_id": { "type": "integer" }, "activity_type_id": { "type": "integer", "description": "ID of pipeline stage that the candidate should be added to, defaults to \"applied\" stage" } } }, "person[list_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[diversity_type_ids][]": { "description": "Unique identifier", "type": "integer" }, "person[compensation]": { "type": "number", "format": "float" }, "person[compensation_notes]": { "type": "string" }, "person[salary]": { "type": "number", "format": "float" }, "person[salary_type_id]": { "type": "integer" }, "person[compensation_currency_id]": { "type": "integer" }, "person[owned_by_id]": { "type": "integer" }, "person[$dynamic_field_key]": { "description": "A custom field for the agency", "type": "string" }, "person[$hierarchy_dynamic_field_key][]": { "type": "string" }, "person[raw_tags][]": { "type": "string" } }, "required": [ "profile_picture", "email" ] } } } } } }, "/{agency_slug}/person_events": { "get": { "operationId": "person_events:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "Page number to return. Starting at 1", "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "activity_type_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "created_by_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "job_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "description": "Sort by created_at", "name": "created_at_sort", "in": "query", "schema": { "type": "string" } }, { "name": "person_id", "in": "query", "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "schema": { "type": "integer" } }, { "name": "created_at_start", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "created_at_end", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "serialization_set", "in": "query", "schema": { "type": "string" } } ] }, "post": { "operationId": "person_events:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_event[activity_type_id]": { "type": "integer" }, "person_event[person_id]": { "type": "integer" }, "person_event[job_id]": { "type": "integer" }, "person_event[company_id]": { "type": "integer" }, "person_event[notes]": { "type": "string" }, "person_event[pinned]": { "type": "boolean" }, "person_event[dragged_and_dropped]": { "type": "boolean" }, "person_event[created_at]": { "description": "Date the entity was created", "type": "string", "format": "datetime" }, "person_event[created_by_id]": { "description": "ID of the user who created this entity", "type": "integer" }, "person_event[updated_at]": { "description": "Date the entity was updated", "type": "string", "format": "datetime" }, "person_event[updated_by_id]": { "description": "ID of the user who updated this entity", "type": "integer" } }, "required": [ "activity_type_id" ] } } } } } }, "/{agency_slug}/person_events/{id}": { "put": { "operationId": "person_events:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_event[activity_type_id]": { "type": "integer" }, "person_event[person_id]": { "type": "integer" }, "person_event[job_id]": { "type": "integer" }, "person_event[company_id]": { "type": "integer" }, "person_event[notes]": { "type": "string" }, "person_event[pinned]": { "type": "boolean" }, "person_event[dragged_and_dropped]": { "type": "boolean" }, "person_event[created_at]": { "description": "Date the entity was created", "type": "string", "format": "datetime" }, "person_event[created_by_id]": { "description": "ID of the user who created this entity", "type": "integer" }, "person_event[updated_at]": { "description": "Date the entity was updated", "type": "string", "format": "datetime" }, "person_event[updated_by_id]": { "description": "ID of the user who updated this entity", "type": "integer" } }, "required": [ "activity_type_id" ] } } } } }, "get": { "operationId": "person_events:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "delete": { "operationId": "person_events:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/person_events/{person_event_id}/documents": { "post": { "operationId": "person_event_documents:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_event_id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "binary" } } } } } } } }, "/{agency_slug}/person_events/{person_event_id}/documents/{id}": { "delete": { "operationId": "person_event_documents:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_event_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/person_events/{person_event_id}/documents/{person_event_document_id}/download": { "get": { "operationId": "person_event_documents:download", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "person_event_id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "name": "person_event_document_id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/person_global_statuses": { "get": { "operationId": "person_global_statuses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/person_lists": { "get": { "operationId": "person_lists:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/person_share_field_types": { "get": { "operationId": "person_share_field_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/person_types": { "get": { "operationId": "person_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/phone_types": { "get": { "operationId": "phone_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/placements": { "post": { "operationId": "placements:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_id": { "type": "integer", "description": "ID of the person being placed" }, "job_id": { "type": "integer", "description": "ID of the job the person is being placed in" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the placement" }, "end_date": { "type": "string", "format": "date", "description": "End date of the placement" }, "salary": { "type": "number", "format": "float", "description": "Salary amount for the placement" }, "salary_currency_id": { "type": "integer", "description": "ID of the currency for the salary" }, "bill_rate": { "type": "number", "format": "float", "description": "Bill rate for the placement" }, "overtime_bill_rate": { "type": "number", "format": "float", "description": "Overtime bill rate for the placement" }, "bill_rate_type_id": { "type": "integer", "description": "ID of the bill rate type" }, "bill_rate_currency_id": { "type": "integer", "description": "ID of the currency for the bill rate" }, "pay_rate": { "type": "number", "format": "float", "description": "Pay rate for the placement" }, "overtime_pay_rate": { "type": "number", "format": "float", "description": "Overtime pay rate for the placement" }, "pay_rate_type_id": { "type": "integer", "description": "ID of the pay rate type" }, "pay_rate_currency_id": { "type": "integer", "description": "ID of the currency for the pay rate" }, "fee": { "type": "number", "format": "float", "description": "Fee amount for the placement" }, "fee_type_id": { "type": "integer", "description": "ID of the fee type" }, "fee_currency_id": { "type": "integer", "description": "ID of the currency for the fee" }, "job_type_id": { "type": "integer", "description": "ID of the job type" }, "notes": { "type": "string", "description": "Notes about the placement" }, "hours": { "type": "number", "format": "float", "description": "Hours for the placement" }, "splits_attributes[]": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the split (for updates)" }, "user_id": { "type": "integer", "description": "ID of the user receiving the split" }, "percentage": { "type": "number", "format": "float", "description": "Percentage of the split" }, "job_owner_type_id": { "type": "integer", "description": "ID of the job owner type" }, "_destroy": { "type": "boolean", "description": "Whether to destroy this split" } } }, "notifications_attributes[]": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the notification (for updates)" }, "user_id": { "type": "integer", "description": "ID of the user to notify" }, "_destroy": { "type": "boolean", "description": "Whether to destroy this notification" } } } }, "required": [ "person_id", "job_id", "start_date" ] } } } } }, "get": { "operationId": "placements:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "ID of the job", "name": "job_id", "in": "query", "schema": { "type": "integer" } }, { "description": "Search query. Supports Lucene query syntax.", "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "person_global_status_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/placements/{id}": { "put": { "operationId": "placements:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_id": { "type": "integer", "description": "ID of the person being placed" }, "job_id": { "type": "integer", "description": "ID of the job the person is being placed in" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the placement" }, "end_date": { "type": "string", "format": "date", "description": "End date of the placement" }, "salary": { "type": "number", "format": "float", "description": "Salary amount for the placement" }, "salary_currency_id": { "type": "integer", "description": "ID of the currency for the salary" }, "bill_rate": { "type": "number", "format": "float", "description": "Bill rate for the placement" }, "overtime_bill_rate": { "type": "number", "format": "float", "description": "Overtime bill rate for the placement" }, "bill_rate_type_id": { "type": "integer", "description": "ID of the bill rate type" }, "bill_rate_currency_id": { "type": "integer", "description": "ID of the currency for the bill rate" }, "pay_rate": { "type": "number", "format": "float", "description": "Pay rate for the placement" }, "overtime_pay_rate": { "type": "number", "format": "float", "description": "Overtime pay rate for the placement" }, "pay_rate_type_id": { "type": "integer", "description": "ID of the pay rate type" }, "pay_rate_currency_id": { "type": "integer", "description": "ID of the currency for the pay rate" }, "fee": { "type": "number", "format": "float", "description": "Fee amount for the placement" }, "fee_type_id": { "type": "integer", "description": "ID of the fee type" }, "fee_currency_id": { "type": "integer", "description": "ID of the currency for the fee" }, "job_type_id": { "type": "integer", "description": "ID of the job type" }, "notes": { "type": "string", "description": "Notes about the placement" }, "hours": { "type": "number", "format": "float", "description": "Hours for the placement" }, "splits_attributes[]": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the split (for updates)" }, "user_id": { "type": "integer", "description": "ID of the user receiving the split" }, "percentage": { "type": "number", "format": "float", "description": "Percentage of the split" }, "job_owner_type_id": { "type": "integer", "description": "ID of the job owner type" }, "_destroy": { "type": "boolean", "description": "Whether to destroy this split" } } }, "notifications_attributes[]": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the notification (for updates)" }, "user_id": { "type": "integer", "description": "ID of the user to notify" }, "_destroy": { "type": "boolean", "description": "Whether to destroy this notification" } } } }, "required": [ "person_id", "job_id", "start_date" ] } } } } }, "delete": { "operationId": "placements:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "placements:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/pronouns": { "get": { "operationId": "pronouns:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/question_types": { "get": { "operationId": "question_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/schedule_items": { "get": { "operationId": "schedule_items:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "person_id", "in": "query", "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/schedule_items/{id}": { "get": { "operationId": "schedule_items:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/scorecards": { "get": { "operationId": "scorecards:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Page number to return. Starting at 1", "name": "page", "in": "query", "schema": { "type": "integer" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "required": false, "name": "person_id", "in": "query", "schema": { "type": "integer" } }, { "required": false, "name": "job_id", "in": "query", "schema": { "type": "integer" } } ] }, "post": { "operationId": "scorecards:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_id": { "type": "integer" }, "job_id": { "type": "integer" }, "user_id": { "type": "integer" }, "external_creator_name": { "type": "string" }, "external_creator_email": { "type": "string" }, "scorecard_type_id": { "type": "integer" }, "scorecard_recommendation_type_id": { "type": "integer" }, "summary": { "type": "string" }, "scorecard_attributes[]": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "score": { "type": "integer" }, "position": { "type": "integer" }, "notes": { "type": "string" }, "_destroy": { "type": "boolean" } } } }, "required": [ "person_id", "scorecard_type_id" ] } } } } } }, "/{agency_slug}/scorecards/{id}": { "delete": { "operationId": "scorecards:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "required": true, "name": "id", "in": "query", "schema": { "type": "integer" } } ] }, "put": { "operationId": "scorecards:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "person_id": { "type": "integer" }, "job_id": { "type": "integer" }, "user_id": { "type": "integer" }, "external_creator_name": { "type": "string" }, "external_creator_email": { "type": "string" }, "scorecard_type_id": { "type": "integer" }, "scorecard_recommendation_type_id": { "type": "integer" }, "summary": { "type": "string" }, "scorecard_attributes[]": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "score": { "type": "integer" }, "position": { "type": "integer" }, "notes": { "type": "string" }, "_destroy": { "type": "boolean" } } }, "id": { "type": "integer" } }, "required": [ "person_id", "scorecard_type_id", "id" ] } } } } }, "get": { "operationId": "scorecards:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/scorecards/scorecard_recommendation_types": { "get": { "operationId": "scorecard_recommendation_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/scorecards/scorecard_templates": { "post": { "operationId": "scorecard_templates:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "job_id": { "type": "integer" }, "name": { "type": "string" }, "scorecard_template_attributes[]": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "_destroy": { "type": "boolean" } } } }, "required": [ "default", "name" ] } } } } }, "get": { "operationId": "scorecard_templates:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "required": false, "name": "job_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/scorecards/scorecard_templates/{id}": { "put": { "operationId": "scorecard_templates:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "job_id": { "type": "integer" }, "name": { "type": "string" }, "scorecard_template_attributes[]": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "_destroy": { "type": "boolean" } } }, "id": { "type": "integer" } }, "required": [ "default", "name", "id" ] } } } } }, "delete": { "operationId": "scorecard_templates:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } }, { "required": true, "name": "id", "in": "query", "schema": { "type": "integer" } } ] }, "get": { "operationId": "scorecard_templates:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/scorecards/scorecard_types": { "get": { "operationId": "scorecard_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/scorecards/scorecard_visibility_types": { "get": { "operationId": "scorecard_visibility_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/seniority_levels": { "get": { "operationId": "seniority_levels:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/sms": { "get": { "operationId": "sms:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "A cursor used to retrieve the next page of results. Returned in each response.", "name": "scroll_id", "in": "query", "schema": { "type": "string" } }, { "description": "Number of results to return in each page", "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "created_at_start", "in": "query", "schema": { "type": "string", "format": "datetime" } }, { "name": "created_at_end", "in": "query", "schema": { "type": "string", "format": "datetime" } } ] }, "post": { "operationId": "sms:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "block_override": { "type": "boolean" }, "from_number": { "type": "string" }, "body": { "type": "string" }, "job_id": { "description": "Unique identifier", "type": "integer" }, "person_id": { "description": "Unique identifier", "type": "integer" }, "target_send_time": { "type": "string", "format": "datetime" }, "to_number": { "type": "string" } }, "required": [ "from_number", "body", "to_number" ] } } } } } }, "/{agency_slug}/sms/{id}": { "get": { "operationId": "sms:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/social_profile_types": { "get": { "operationId": "social_profile_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/source_types": { "post": { "operationId": "source_types:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "source_type[name]": { "type": "string" }, "source_type[publishable]": { "type": "boolean" }, "source_type[active]": { "type": "boolean" }, "source_type[hidden]": { "type": "boolean" }, "source_type[created_at]": { "description": "Date the entity was created", "type": "string", "format": "datetime" }, "source_type[updated_at]": { "description": "Date the entity was updated", "type": "string", "format": "datetime" }, "source_type[created_by_id]": { "description": "ID of the user who created this entity", "type": "integer" }, "source_type[updated_by_id]": { "description": "ID of the user who updated this entity", "type": "integer" } } } } } } }, "get": { "operationId": "source_types:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Return all records with a higher ID", "name": "after_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/source_types/{id}": { "delete": { "operationId": "source_types:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "get": { "operationId": "source_types:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "source_types:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "source_type[name]": { "type": "string" }, "source_type[publishable]": { "type": "boolean" }, "source_type[active]": { "type": "boolean" }, "source_type[hidden]": { "type": "boolean" }, "source_type[created_at]": { "description": "Date the entity was created", "type": "string", "format": "datetime" }, "source_type[updated_at]": { "description": "Date the entity was updated", "type": "string", "format": "datetime" }, "source_type[created_by_id]": { "description": "ID of the user who created this entity", "type": "integer" }, "source_type[updated_by_id]": { "description": "ID of the user who updated this entity", "type": "integer" } } } } } } } }, "/{agency_slug}/users": { "get": { "operationId": "users:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/veteran_statuses": { "get": { "operationId": "veteran_statuses:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } }, "/{agency_slug}/webhooks": { "get": { "operationId": "webhooks:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] }, "post": { "operationId": "webhooks:create", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "webhook[item_type]": { "type": "string", "description": "Can be one of the following:\n- candidate\n- company\n- deal\n- job\n- person_education_profile\n- person_event\n- person_job_profile\n- person\n- placement_split\n- placement\n" }, "webhook[action]": { "type": "string", "description": "Can be one of the following:\n- create\n- update\n- destroy\n" }, "webhook[endpoint_url]": { "type": "string" } }, "required": [ "item_type", "action", "endpoint_url" ] } } } } } }, "/{agency_slug}/webhooks/{id}": { "delete": { "operationId": "webhooks:destroy", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] }, "put": { "operationId": "webhooks:update", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "webhook[item_type]": { "type": "string", "description": "Can be one of the following:\n- candidate\n- company\n- deal\n- job\n- person_education_profile\n- person_event\n- person_job_profile\n- person\n- placement_split\n- placement\n" }, "webhook[action]": { "type": "string", "description": "Can be one of the following:\n- create\n- update\n- destroy\n" }, "webhook[endpoint_url]": { "type": "string" } } } } } } }, "get": { "operationId": "webhooks:show", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/workflow_stages": { "get": { "operationId": "workflow_stages:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } }, { "description": "Unique identifier", "name": "workflow_id", "in": "query", "schema": { "type": "integer" } } ] } }, "/{agency_slug}/workflows": { "get": { "operationId": "workflows:index", "responses": { "200": { "description": "success", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "agency_slug", "required": true, "in": "path", "schema": { "type": "string" } } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } }