{ "openapi": "3.0.0", "info": { "title": "Ezekia", "description": "### Software for Search Firms\n\nIntuitive, easy to use, fast and customizable\n\n> ### ⚠️ v1 and v2 will be removed on 1 January 2027\n>\n> Endpoints marked **deprecated** below stop working on their listed date. Move to the latest version available, `/api/v4`.\n>\n> **If your requests have no version in the URL, this affects you.**\n>\n> A call to `/api/people` is served by v1, so it is being removed on the same date even\n> though that unversioned form does not appear in this document. Look the endpoint up\n> below under `/api/v4` and migrate to that.\n>\n> The few version-free paths that *are* listed below — those documented without any\n> `/v{n}` prefix — are deliberate exceptions. They belong to no version, are not\n> marked deprecated, and are unaffected by these removals.\n>\n> Adding `/v4` is not always a drop-in change: where a later version redefined an\n> endpoint, the request or response differs from what v1 returns. Check the operation\n> below before switching.", "termsOfService": "https://ezekia.com/#/terms/subscription-agreement", "contact": { "email": "support@ezekia.com" }, "version": "2.1.1" }, "servers": [ { "url": "https://ezekia.com/api" } ], "paths": { "/v1/search-users": { "get": { "tags": [ "Search Firm Users" ], "summary": "Fetches all users for the search firm", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/search-users` instead.\n\nIf you call `/api/search-users` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/search-users`.", "operationId": "v1.v1.search-users.index", "parameters": [ { "name": "q", "in": "query", "description": "A query string to filter the results by name or email.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.count", "name": "count", "in": "query", "description": "Specify how many records to be returned per page.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/people/{personId}/emails": { "post": { "tags": [ "People (Emails)" ], "summary": "Adds a new email address to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails` instead.\n\nIf you call `/api/people/{personId}/emails` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/emails`.", "operationId": "v1.v1.people.emails.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/emails/{emailId}": { "put": { "tags": [ "People (Emails)" ], "summary": "Updates an email address on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails/{emailId}` instead.\n\nIf you call `/api/people/{personId}/emails/{emailId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/emails/{emailId}`.", "operationId": "v1.v1.people.emails.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be changed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Emails)" ], "summary": "Deletes an email address from a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails/{emailId}` instead.\n\nIf you call `/api/people/{personId}/emails/{emailId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/emails/{emailId}`.", "operationId": "v1.v1.people.emails.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be removed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v1/people/{personId}/phones": { "post": { "tags": [ "People (Phones)" ], "summary": "Adds a new phone number to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones` instead.\n\nIf you call `/api/people/{personId}/phones` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/phones`.", "operationId": "v1.v1.people.phones.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/phones/{phoneId}": { "put": { "tags": [ "People (Phones)" ], "summary": "Updates an phone number on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones/{phoneId}` instead.\n\nIf you call `/api/people/{personId}/phones/{phoneId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/phones/{phoneId}`.", "operationId": "v1.v1.people.phones.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Phones)" ], "summary": "Deletes an phone number from a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones/{phoneId}` instead.\n\nIf you call `/api/people/{personId}/phones/{phoneId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/phones/{phoneId}`.", "operationId": "v1.v1.people.phones.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v1/people/tags/{tagId}": { "post": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Adds tags to people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/tags/{tagId}` instead.\n\nIf you call `/api/people/tags/{tagId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/tags/{tagId}`.", "operationId": "v1.v1.tags.store", "requestBody": { "description": "The body for adding tags to people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } }, "deprecated": true }, "delete": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Removes tags from people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/tags/{tagId}` instead.\n\nIf you call `/api/people/tags/{tagId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/tags/{tagId}`.", "operationId": "v1.v1.tags.destroy", "requestBody": { "description": "The body for removing tags from people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } }, "deprecated": true } }, "/v1/people": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches all people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people` instead.\n\nIf you call `/api/people` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people`.", "operationId": "v1.v1.people.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "People (Profile)" ], "summary": "Creates a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people` instead.\n\nIf you call `/api/people` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people`.", "operationId": "v1.v1.people.store", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.person.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches a person by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.\n\nIf you call `/api/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}`.", "operationId": "v1.v1.people.show", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person" } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } }, "deprecated": true }, "put": { "tags": [ "People (Profile)" ], "summary": "Updates a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.\n\nIf you call `/api/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}`.", "operationId": "v1.v1.people.update", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.person.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person" } }, "type": "object" } } } }, "422": { "description": "Person with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Profile)" ], "summary": "Deletes a person by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.\n\nIf you call `/api/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}`.", "operationId": "v1.v1.people.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } }, "deprecated": true } }, "/v1/projects": { "get": { "tags": [ "Projects" ], "summary": "Fetches all projects.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects` instead.\n\nIf you call `/api/projects` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects`.", "operationId": "v1.v1.projects.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.project.filterOn" }, { "$ref": "#/components/parameters/api.project.fields" }, { "$ref": "#/components/parameters/api.project.exclude" }, { "$ref": "#/components/parameters/api.project.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.project.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, { "name": "isAssignment", "in": "query", "description": "By setting this parameter only assignments will be returned in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "isOpportunity", "in": "query", "description": "By setting this parameter only opportunities will be returned in the response.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Projects" ], "summary": "Creates a project", "description": "Store a newly created resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects` instead.\n\nIf you call `/api/projects` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects`.", "operationId": "v1.v1.projects.store", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.project.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Fetches a project by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.\n\nIf you call `/api/projects/{projectId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}`.", "operationId": "v1.v1.projects.show", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "put": { "tags": [ "Projects" ], "summary": "Updates a project", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.\n\nIf you call `/api/projects/{projectId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}`.", "operationId": "v1.v1.projects.update", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.project.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "delete": { "tags": [ "Projects" ], "summary": "Deletes a project by ID", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.\n\nIf you call `/api/projects/{projectId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}`.", "operationId": "v1.v1.projects.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that project." } }, "deprecated": true } }, "/v1/statuses/{typeId}": { "get": { "tags": [ "Status tags" ], "summary": "Fetches all status tags of a particular type.", "description": "The authorization is done in the methods as the actions are shared\nbetween the different model types.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/statuses/{typeId}` instead.\n\nIf you call `/api/statuses/{typeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/statuses/{typeId}`.", "operationId": "v1.v1.statuses.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of tag.", "required": true, "schema": { "type": "string", "enum": [ "assignment", "list", "candidate", "lead", "person", "opportunity", "client", "task", "meeting", "revenue", "invoice", "note" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/assignments/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to an assignment.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/candidates` instead.\n\nIf you call `/api/assignments/candidates` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/candidates`.", "operationId": "v1.v1.assignments.candidates.store", "requestBody": { "description": "The body for adding candidates to assignments.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the assignment cannot be found." } }, "deprecated": true } }, "/v1/assignments/{assignmentId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}` instead.\n\nIf you call `/api/assignments/{assignmentId}/candidates/statuses/{tagId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}`.", "operationId": "v1.v1.assignments.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } }, "deprecated": true }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}` instead.\n\nIf you call `/api/assignments/{assignmentId}/candidates/statuses/{tagId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}`.", "operationId": "v1.v1.assignments.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } }, "deprecated": true } }, "/v1/projects/{projectId}/candidates": { "get": { "tags": [ "Projects (Candidates)" ], "summary": "Fetches candidates from a specific assignment.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/candidates` instead.\n\nIf you call `/api/projects/{projectId}/candidates` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/candidates`.", "operationId": "v1.v1.projects.candidates.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The assignment ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fieldsWithCandidate" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/people/notes": { "post": { "tags": [ "People (Notes)", "Notes" ], "summary": "Adds notes to one or more people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes` instead.\n\nIf you call `/api/people/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/notes`.", "operationId": "v1.v1.", "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.note.storeRequest" }, { "properties": { "people": { "description": "An array of person IDs that will have the notes added.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } ] } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.notesUpdateResponse" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/notes/{noteId}": { "put": { "tags": [ "People (Notes)", "Notes" ], "summary": "Updates a note.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes/{noteId}` instead.\n\nIf you call `/api/people/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/notes/{noteId}`.", "operationId": "v1.v1..2", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Notes)", "Notes" ], "summary": "Deletes a note.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes/{noteId}` instead.\n\nIf you call `/api/people/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/notes/{noteId}`.", "operationId": "v1.v1..3", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that note." } }, "deprecated": true } }, "/v1/companies/{companyId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes` instead.\n\nIf you call `/api/companies/{companyId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/notes`.", "operationId": "v1.v1.companies.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes` instead.\n\nIf you call `/api/companies/{companyId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/notes`.", "operationId": "v1.v1.companies.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes` instead.\n\nIf you call `/api/projects/{projectId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/notes`.", "operationId": "v1.v1.projects.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes` instead.\n\nIf you call `/api/projects/{projectId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/notes`.", "operationId": "v1.v1.projects.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/notes`.", "operationId": "v1.v1.assignments.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/notes`.", "operationId": "v1.v1.assignments.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes` instead.\n\nIf you call `/api/opportunities/{opportunityId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/notes`.", "operationId": "v1.v1.opportunities.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes` instead.\n\nIf you call `/api/opportunities/{opportunityId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/notes`.", "operationId": "v1.v1.opportunities.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes` instead.\n\nIf you call `/api/people/{personId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/notes`.", "operationId": "v1.v1.people.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes` instead.\n\nIf you call `/api/people/{personId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/notes`.", "operationId": "v1.v1.people.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes` instead.\n\nIf you call `/api/lists/{searchFirmListId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/notes`.", "operationId": "v1.v1.lists.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes` instead.\n\nIf you call `/api/lists/{searchFirmListId}/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/notes`.", "operationId": "v1.v1.lists.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes/{noteId}` instead.\n\nIf you call `/api/companies/{companyId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/notes/{noteId}`.", "operationId": "v1.v1.companies.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes/{noteId}` instead.\n\nIf you call `/api/companies/{companyId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/notes/{noteId}`.", "operationId": "v1.v1.companies.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes/{noteId}` instead.\n\nIf you call `/api/projects/{projectId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/notes/{noteId}`.", "operationId": "v1.v1.projects.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes/{noteId}` instead.\n\nIf you call `/api/projects/{projectId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/notes/{noteId}`.", "operationId": "v1.v1.projects.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}`.", "operationId": "v1.v1.assignments.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}`.", "operationId": "v1.v1.assignments.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes/{noteId}` instead.\n\nIf you call `/api/opportunities/{opportunityId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/notes/{noteId}`.", "operationId": "v1.v1.opportunities.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes/{noteId}` instead.\n\nIf you call `/api/opportunities/{opportunityId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/notes/{noteId}`.", "operationId": "v1.v1.opportunities.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes/{noteId}` instead.\n\nIf you call `/api/people/{personId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/notes/{noteId}`.", "operationId": "v1.v1.people.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes/{noteId}` instead.\n\nIf you call `/api/people/{personId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/notes/{noteId}`.", "operationId": "v1.v1.people.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes/{noteId}` instead.\n\nIf you call `/api/lists/{searchFirmListId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/notes/{noteId}`.", "operationId": "v1.v1.lists.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes/{noteId}` instead.\n\nIf you call `/api/lists/{searchFirmListId}/notes/{noteId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/notes/{noteId}`.", "operationId": "v1.v1.lists.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/documents` instead.\n\nIf you call `/api/companies/{companyId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/documents`.", "operationId": "v1.v1.companies.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/documents` instead.\n\nIf you call `/api/projects/{projectId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/documents`.", "operationId": "v1.v1.projects.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/documents` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/documents`.", "operationId": "v1.v1.assignments.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/documents` instead.\n\nIf you call `/api/opportunities/{opportunityId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/documents`.", "operationId": "v1.v1.opportunities.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/documents` instead.\n\nIf you call `/api/people/{personId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/documents`.", "operationId": "v1.v1.people.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/documents` instead.\n\nIf you call `/api/lists/{searchFirmListId}/documents` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/documents`.", "operationId": "v1.v1.lists.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/tasks` instead.\n\nIf you call `/api/companies/{companyId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/tasks`.", "operationId": "v1.v1.companies.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/projects/{projectId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/tasks` instead.\n\nIf you call `/api/projects/{projectId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/tasks`.", "operationId": "v1.v1.projects.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/tasks` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/tasks`.", "operationId": "v1.v1.assignments.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/tasks` instead.\n\nIf you call `/api/opportunities/{opportunityId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/tasks`.", "operationId": "v1.v1.opportunities.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/people/{personId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/tasks` instead.\n\nIf you call `/api/people/{personId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/tasks`.", "operationId": "v1.v1.people.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/tasks` instead.\n\nIf you call `/api/lists/{searchFirmListId}/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/tasks`.", "operationId": "v1.v1.lists.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/companies/{companyId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/meetings` instead.\n\nIf you call `/api/companies/{companyId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/meetings`.", "operationId": "v1.v1.companies.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/projects/{projectId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/meetings` instead.\n\nIf you call `/api/projects/{projectId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/meetings`.", "operationId": "v1.v1.projects.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/meetings` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/meetings`.", "operationId": "v1.v1.assignments.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/meetings` instead.\n\nIf you call `/api/opportunities/{opportunityId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/meetings`.", "operationId": "v1.v1.opportunities.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/people/{personId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/meetings` instead.\n\nIf you call `/api/people/{personId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/meetings`.", "operationId": "v1.v1.people.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/meetings` instead.\n\nIf you call `/api/lists/{searchFirmListId}/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/meetings`.", "operationId": "v1.v1.lists.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/companies/{companyId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.\n\nIf you call `/api/companies/{companyId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/additional-info`.", "operationId": "v1.v1.companies.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.\n\nIf you call `/api/companies/{companyId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/additional-info`.", "operationId": "v1.v1.companies.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.\n\nIf you call `/api/companies/{companyId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/additional-info`.", "operationId": "v1.v1.companies.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.\n\nIf you call `/api/projects/{projectId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/additional-info`.", "operationId": "v1.v1.projects.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.\n\nIf you call `/api/projects/{projectId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/additional-info`.", "operationId": "v1.v1.projects.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.\n\nIf you call `/api/projects/{projectId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/additional-info`.", "operationId": "v1.v1.projects.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/additional-info`.", "operationId": "v1.v1.assignments.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/additional-info`.", "operationId": "v1.v1.assignments.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/additional-info`.", "operationId": "v1.v1.assignments.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.\n\nIf you call `/api/opportunities/{opportunityId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/additional-info`.", "operationId": "v1.v1.opportunities.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.\n\nIf you call `/api/opportunities/{opportunityId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/additional-info`.", "operationId": "v1.v1.opportunities.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.\n\nIf you call `/api/opportunities/{opportunityId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/additional-info`.", "operationId": "v1.v1.opportunities.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.\n\nIf you call `/api/people/{personId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/additional-info`.", "operationId": "v1.v1.people.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.\n\nIf you call `/api/people/{personId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/additional-info`.", "operationId": "v1.v1.people.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.\n\nIf you call `/api/people/{personId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/additional-info`.", "operationId": "v1.v1.people.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.\n\nIf you call `/api/lists/{searchFirmListId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/additional-info`.", "operationId": "v1.v1.lists.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.\n\nIf you call `/api/lists/{searchFirmListId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/additional-info`.", "operationId": "v1.v1.lists.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.\n\nIf you call `/api/lists/{searchFirmListId}/additional-info` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/additional-info`.", "operationId": "v1.v1.lists.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/status/{statusId}` instead.\n\nIf you call `/api/companies/{companyId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/status/{statusId}`.", "operationId": "v1.v1.companies.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/status/{statusId}` instead.\n\nIf you call `/api/projects/{projectId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/status/{statusId}`.", "operationId": "v1.v1.projects.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/assignments/{searchFirmBriefId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/status/{statusId}` instead.\n\nIf you call `/api/assignments/{searchFirmBriefId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/assignments/{searchFirmBriefId}/status/{statusId}`.", "operationId": "v1.v1.assignments.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/status/{statusId}` instead.\n\nIf you call `/api/opportunities/{opportunityId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/status/{statusId}`.", "operationId": "v1.v1.opportunities.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/status/{statusId}` instead.\n\nIf you call `/api/people/{personId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/status/{statusId}`.", "operationId": "v1.v1.people.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{searchFirmListId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/status/{statusId}` instead.\n\nIf you call `/api/lists/{searchFirmListId}/status/{statusId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{searchFirmListId}/status/{statusId}`.", "operationId": "v1.v1.lists.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/off-limits/agreements/companies/{companyId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/companies/{companyId}` instead.\n\nIf you call `/api/off-limits/agreements/companies/{companyId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/companies/{companyId}`.", "operationId": "v1.v1.companies.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/off-limits/agreements/people/{personId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/people/{personId}` instead.\n\nIf you call `/api/off-limits/agreements/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/people/{personId}`.", "operationId": "v1.v1.people.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/companies/{companyId}/links": { "post": { "tags": [ "Companies (Links)" ], "summary": "Adds a new link to a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links` instead.\n\nIf you call `/api/companies/{companyId}/links` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/links`.", "operationId": "v1.v1.companies.links.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/links": { "post": { "tags": [ "People (Links)" ], "summary": "Adds a new link to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links` instead.\n\nIf you call `/api/people/{personId}/links` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/links`.", "operationId": "v1.v1.people.links.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}/links/{linkId}": { "put": { "tags": [ "Companies (Links)" ], "summary": "Updates a link on a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links/{linkId}` instead.\n\nIf you call `/api/companies/{companyId}/links/{linkId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/links/{linkId}`.", "operationId": "v1.v1.companies.links.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies (Links)" ], "summary": "Deletes a link on a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links/{linkId}` instead.\n\nIf you call `/api/companies/{companyId}/links/{linkId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}/links/{linkId}`.", "operationId": "v1.v1.companies.links.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v1/people/{personId}/links/{linkId}": { "put": { "tags": [ "People (Links)" ], "summary": "Updates a link on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links/{linkId}` instead.\n\nIf you call `/api/people/{personId}/links/{linkId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/links/{linkId}`.", "operationId": "v1.v1.people.links.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Links)" ], "summary": "Deletes a link on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links/{linkId}` instead.\n\nIf you call `/api/people/{personId}/links/{linkId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/links/{linkId}`.", "operationId": "v1.v1.people.links.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v1/custom-fields/{typeId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves all custom fields of a particular type", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/custom-fields/{typeId}` instead.\n\nIf you call `/api/custom-fields/{typeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/custom-fields/{typeId}`.", "operationId": "v1.v1.custom-fields.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/custom-fields/{typeId}/{customFieldId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves a custom field by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/custom-fields/{typeId}/{customFieldId}` instead.\n\nIf you call `/api/custom-fields/{typeId}/{customFieldId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/custom-fields/{typeId}/{customFieldId}`.", "operationId": "v1.v1.custom-fields.show", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "customFieldId", "in": "path", "description": "The custom field ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/lists": { "get": { "tags": [ "Lists" ], "summary": "Fetches all lists.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists` instead.\n\nIf you call `/api/lists` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists`.", "operationId": "v1.v1.lists.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.list.fields" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.list" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Lists" ], "summary": "Creates a list", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists` instead.\n\nIf you call `/api/lists` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists`.", "operationId": "v1.v1.lists.store", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/lists/{search_firm_listId}": { "get": { "tags": [ "Lists" ], "summary": "Fetches a list by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.\n\nIf you call `/api/lists/{search_firm_listId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{search_firm_listId}`.", "operationId": "v1.v1.lists.show", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "List with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } }, "deprecated": true }, "put": { "tags": [ "Lists" ], "summary": "Updates a list", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.\n\nIf you call `/api/lists/{search_firm_listId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{search_firm_listId}`.", "operationId": "v1.v1.lists.update", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "List with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } }, "deprecated": true }, "delete": { "tags": [ "Lists" ], "summary": "Deletes a list by ID", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.\n\nIf you call `/api/lists/{search_firm_listId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{search_firm_listId}`.", "operationId": "v1.v1.lists.destroy", "parameters": [ { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "List with that ID doesn't exist." } }, "deprecated": true } }, "/v1/lists/{projectId}/people": { "get": { "tags": [ "Lists", "People (Lists)" ], "summary": "Fetches all people in a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people` instead.\n\nIf you call `/api/lists/{projectId}/people` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{projectId}/people`.", "operationId": "v1.v1.lists.people.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.lead.status" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/lists/{projectId}/people/{personId}": { "put": { "tags": [ "Lists", "People (Lists)" ], "summary": "Add a person to a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people/{personId}` instead.\n\nIf you call `/api/lists/{projectId}/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{projectId}/people/{personId}`.", "operationId": "v1.v1.lists.people.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" }, "meta": { "properties": { "person": { "$ref": "#/components/schemas/api.person" }, "updated": { "$ref": "#/components/schemas/api.listPeopleUpdateResponse" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "delete": { "tags": [ "Lists", "People (Lists)" ], "summary": "Remove a person from a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people/{personId}` instead.\n\nIf you call `/api/lists/{projectId}/people/{personId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/lists/{projectId}/people/{personId}`.", "operationId": "v1.v1.lists.people.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/companies": { "get": { "tags": [ "Companies" ], "summary": "Fetches all companies.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies` instead.\n\nIf you call `/api/companies` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies`.", "operationId": "v1.v1.companies.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned companies will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Companies" ], "summary": "Creates a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies` instead.\n\nIf you call `/api/companies` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies`.", "operationId": "v1.v1.companies.store", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.company.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.\n\nIf you call `/api/companies/{companyId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}`.", "operationId": "v1.v1.companies.show", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Updates a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.\n\nIf you call `/api/companies/{companyId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}`.", "operationId": "v1.v1.companies.update", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.company.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Deletes a company by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.\n\nIf you call `/api/companies/{companyId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/companies/{companyId}`.", "operationId": "v1.v1.companies.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that company." } }, "deprecated": true } }, "/v1/clients": { "get": { "tags": [ "Clients" ], "summary": "Fetches all clients.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/clients` instead.\n\nIf you call `/api/clients` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/clients`.", "operationId": "v1.v1.clients.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned clients will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/people/{personId}/positions": { "get": { "tags": [ "People (Positions)" ], "summary": "Gets all positions for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions` instead.\n\nIf you call `/api/people/{personId}/positions` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/positions`.", "operationId": "v1.v1.people.positions.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.position.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "startDate" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "People (Positions)" ], "summary": "Creates a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions` instead.\n\nIf you call `/api/people/{personId}/positions` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/positions`.", "operationId": "v1.v1.people.positions.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/positions/{positionId}": { "put": { "tags": [ "People (Positions)" ], "summary": "Updates a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions/{positionId}` instead.\n\nIf you call `/api/people/{personId}/positions/{positionId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/positions/{positionId}`.", "operationId": "v1.v1.people.positions.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The ID of the position", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Positions)" ], "summary": "Deletes a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions/{positionId}` instead.\n\nIf you call `/api/people/{personId}/positions/{positionId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/positions/{positionId}`.", "operationId": "v1.v1.people.positions.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The position ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Position with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that position." } }, "deprecated": true } }, "/v1/people/{personId}/education": { "get": { "tags": [ "People (Education/Qualifications)" ], "summary": "Gets all educations for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education` instead.\n\nIf you call `/api/people/{personId}/education` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/education`.", "operationId": "v1.v1.people.education.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.education.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "start" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "People (Education/Qualifications)" ], "summary": "Creates a education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education` instead.\n\nIf you call `/api/people/{personId}/education` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/education`.", "operationId": "v1.v1.people.education.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/education/{educationId}": { "put": { "tags": [ "People (Education/Qualifications)" ], "summary": "Updates an education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education/{educationId}` instead.\n\nIf you call `/api/people/{personId}/education/{educationId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/education/{educationId}`.", "operationId": "v1.v1.people.education.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The ID of the education", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Education/Qualifications)" ], "summary": "Deletes an education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education/{educationId}` instead.\n\nIf you call `/api/people/{personId}/education/{educationId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/education/{educationId}`.", "operationId": "v1.v1.people.education.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The education ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Education with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that education." } }, "deprecated": true } }, "/v1/people/{personId}/confidential": { "post": { "tags": [ "People (Confidential Details)" ], "summary": "Sets confidential details for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/confidential` instead.\n\nIf you call `/api/people/{personId}/confidential` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/confidential`.", "operationId": "v1.v1.people.confidential.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The confidential details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.confidential.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.confidential" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/aspirations": { "post": { "tags": [ "People (Aspirations)" ], "summary": "Sets aspiration details for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/aspirations` instead.\n\nIf you call `/api/people/{personId}/aspirations` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/aspirations`.", "operationId": "v1.v1.people.aspirations.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The aspiration details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.aspiration.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.aspiration" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/languages": { "post": { "tags": [ "People (Languages)" ], "summary": "Add a language for a person", "description": "Adds a new language or updates an existing language for a candidate.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/languages` instead.\n\nIf you call `/api/people/{personId}/languages` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/languages`.", "operationId": "v1.v1.people.languages.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The language details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.language.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.language" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/languages/{languageId}": { "delete": { "tags": [ "People (Languages)" ], "summary": "Delete a language for a person", "description": "Deletes a language for a candidate.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/languages/{languageId}` instead.\n\nIf you call `/api/people/{personId}/languages/{languageId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/languages/{languageId}`.", "operationId": "v1.v1.people.languages.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "languageId", "in": "path", "description": "The ID of the language", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Language with that ID doesn't exist." } }, "deprecated": true } }, "/v1/people/{personId}/current-status": { "post": { "tags": [ "People (Current Status)" ], "summary": "Sets current status for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/current-status` instead.\n\nIf you call `/api/people/{personId}/current-status` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/current-status`.", "operationId": "v1.v1.people.current-status.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The current status body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.currentStatus.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.currentStatus" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/people/{personId}/profile-picture": { "post": { "tags": [ "People (Profile)" ], "summary": "Update a person's profile picture", "description": "Update candidate profile picture\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/profile-picture` instead.\n\nIf you call `/api/people/{personId}/profile-picture` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/profile-picture`.", "operationId": "v1.v1.people.profile-picture.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/api.candidate.profilePicture.storeRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/languages/codes": { "get": { "tags": [ "People (Languages)" ], "summary": "Get all language codes and names", "description": "Returns a list of all language codes and their corresponding names.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/languages/codes` instead.\n\nIf you call `/api/languages/codes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/languages/codes`.", "operationId": "v1.v1.languages.codes", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.language.codes" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/notes": { "get": { "tags": [ "Notes" ], "summary": "Fetches all notes", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/notes` instead.\n\nIf you call `/api/notes` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/notes`.", "operationId": "v1.v1.notes.forFirm", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "name": "type", "in": "query", "description": "Filter the results by the type of parent model.", "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "query", "description": "The ID of the parent model", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.firm.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/revenues": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches all revenues.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues` instead.\n\nIf you call `/api/revenues` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/revenues`.", "operationId": "v1.v1..4", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.revenue" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/invoices": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all invoices.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices` instead.\n\nIf you call `/api/invoices` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoices`.", "operationId": "v1.v1..5", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.invoice.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.invoice.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees` instead.\n\nIf you call `/api/fixed-fees` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/fixed-fees`.", "operationId": "v1.v1..6", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/percent-splits": { "get": { "tags": [ "Billing (Percent Splits)" ], "summary": "Fetches all percent splits.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/percent-splits` instead.\n\nIf you call `/api/percent-splits` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/percent-splits`.", "operationId": "v1.v1..7", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/fixed-fees/{fixedFeeId}": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches a fixed fee by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}` instead.\n\nIf you call `/api/fixed-fees/{fixedFeeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/fixed-fees/{fixedFeeId}`.", "operationId": "v1.v1.fixed-fees.show", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Deletes fixed fee item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}` instead.\n\nIf you call `/api/fixed-fees/{fixedFeeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/fixed-fees/{fixedFeeId}`.", "operationId": "v1.v1.fixed-fees.destroy", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Fixed fee with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/fixed-fees/{fixedFeeId}/lock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Locks a fixed fee.", "description": "Lock fixed fee\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}/lock` instead.\n\nIf you call `/api/fixed-fees/{fixedFeeId}/lock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/fixed-fees/{fixedFeeId}/lock`.", "operationId": "v1.v1.fixed-fees.lock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/fixed-fees/{fixedFeeId}/unlock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Unlocks a fixed fee.", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}/unlock` instead.\n\nIf you call `/api/fixed-fees/{fixedFeeId}/unlock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/fixed-fees/{fixedFeeId}/unlock`.", "operationId": "v1.v1.fixed-fees.unlock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/revenues/{revenueId}": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches a revenue by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}` instead.\n\nIf you call `/api/revenues/{revenueId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/revenues/{revenueId}`.", "operationId": "v1.v1.revenues.show", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Revenues)" ], "summary": "Deletes revenue item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}` instead.\n\nIf you call `/api/revenues/{revenueId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/revenues/{revenueId}`.", "operationId": "v1.v1.revenues.destroy", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/revenues/{revenueId}/lock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Locks a revenue.", "description": "Lock revenue\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}/lock` instead.\n\nIf you call `/api/revenues/{revenueId}/lock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/revenues/{revenueId}/lock`.", "operationId": "v1.v1.revenues.lock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/revenues/{revenueId}/unlock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Unlocks a revenue.", "description": "Unlock revenue\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}/unlock` instead.\n\nIf you call `/api/revenues/{revenueId}/unlock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/revenues/{revenueId}/unlock`.", "operationId": "v1.v1.revenues.unlock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/invoices/{invoiceId}": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches a invoice by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}` instead.\n\nIf you call `/api/invoices/{invoiceId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoices/{invoiceId}`.", "operationId": "v1.v1.invoices.show", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The invoice ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that invoice." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Invoices)" ], "summary": "Deletes an invoice by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}` instead.\n\nIf you call `/api/invoices/{invoiceId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoices/{invoiceId}`.", "operationId": "v1.v1.invoices.destroy", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/invoices/{invoiceId}/lock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Locks an invoice.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}/lock` instead.\n\nIf you call `/api/invoices/{invoiceId}/lock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoices/{invoiceId}/lock`.", "operationId": "v1.v1.invoices.lock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.lockInvoice" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/invoices/{invoiceId}/unlock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Unlocks an invoice.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}/unlock` instead.\n\nIf you call `/api/invoices/{invoiceId}/unlock` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoices/{invoiceId}/unlock`.", "operationId": "v1.v1.invoices.unlock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/billing": { "get": { "tags": [ "Billing" ], "summary": "Fetches billing information for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing` instead.\n\nIf you call `/api/projects/{projectId}/billing` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/billing`.", "operationId": "v1.v1.projects.billing", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v1/projects/{projectId}/revenues": { "post": { "tags": [ "Billing (Revenues)" ], "summary": "Creates a revenue.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/revenues` instead.\n\nIf you call `/api/projects/{projectId}/revenues` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/revenues`.", "operationId": "v1.v1.projects.revenues.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/revenues/{revenueId}": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Updates a revenue", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/revenues/{revenueId}` instead.\n\nIf you call `/api/projects/{projectId}/revenues/{revenueId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/revenues/{revenueId}`.", "operationId": "v1.v1.projects.revenues.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "revenueId", "in": "path", "description": "The ID of the revenue", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/invoices": { "post": { "tags": [ "Billing (Invoices)" ], "summary": "Adds invoice to billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/invoices` instead.\n\nIf you call `/api/projects/{projectId}/invoices` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/invoices`.", "operationId": "v1.v1.projects.invoices.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/invoices/{invoiceId}": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Updates an invoice.", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/invoices/{invoiceId}` instead.\n\nIf you call `/api/projects/{projectId}/invoices/{invoiceId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/invoices/{invoiceId}`.", "operationId": "v1.v1.projects.invoices.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees by project ID.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees` instead.\n\nIf you call `/api/projects/{projectId}/fixed-fees` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/fixed-fees`.", "operationId": "v1.v1.projects.fixed-fees.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "post": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Adds new fixed fee to billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees` instead.\n\nIf you call `/api/projects/{projectId}/fixed-fees` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/fixed-fees`.", "operationId": "v1.v1.projects.fixed-fees.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/fixed-fees/{fixed_feeId}": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Updates a fixed fee.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees/{fixed_feeId}` instead.\n\nIf you call `/api/projects/{projectId}/fixed-fees/{fixed_feeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/fixed-fees/{fixed_feeId}`.", "operationId": "v1.v1.projects.fixed-fees.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "fixed_feeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/billing/contact": { "get": { "tags": [ "Billing" ], "summary": "Fetches the project billing contact", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact` instead.\n\nIf you call `/api/projects/{projectId}/billing/contact` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/billing/contact`.", "operationId": "v1.v1.projects.billing.contact.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project or that project's billing information." } }, "deprecated": true }, "post": { "tags": [ "Billing" ], "summary": "Adds the contact to a project billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact` instead.\n\nIf you call `/api/projects/{projectId}/billing/contact` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/billing/contact`.", "operationId": "v1.v1.projects.billing.contact.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The billing contact body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.full" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/projects/{projectId}/billing/contact/{contactId}": { "delete": { "tags": [ "Billing" ], "summary": "Removes the contact from project billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact/{contactId}` instead.\n\nIf you call `/api/projects/{projectId}/billing/contact/{contactId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/projects/{projectId}/billing/contact/{contactId}`.", "operationId": "v1.v1.projects.billing.contact", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/invoice-templates": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all the invoice templates.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoice-templates` instead.\n\nIf you call `/api/invoice-templates` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/invoice-templates`.", "operationId": "v1.v1.invoice-templates.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoiceTemplate" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/off-limits/agreements/{modelType}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for people or companies", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}` instead.\n\nIf you call `/api/off-limits/agreements/{modelType}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/{modelType}`.", "operationId": "v1.v1.offlimits-agreements.index", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Off-Limits" ], "summary": "Creates an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}` instead.\n\nIf you call `/api/off-limits/agreements/{modelType}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/{modelType}`.", "operationId": "v1.v1.offlimits-agreements.store", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } } ], "requestBody": { "description": "The body for creating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/off-limits/agreements/{modelType}/{agreementId}": { "put": { "tags": [ "Off-Limits" ], "summary": "Updates an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}/{agreementId}` instead.\n\nIf you call `/api/off-limits/agreements/{modelType}/{agreementId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/{modelType}/{agreementId}`.", "operationId": "v1.v1.offlimits-agreements.update", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Item with that ID doesn't exist." } }, "deprecated": true }, "delete": { "tags": [ "Off-Limits" ], "summary": "Deletes an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}/{agreementId}` instead.\n\nIf you call `/api/off-limits/agreements/{modelType}/{agreementId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/off-limits/agreements/{modelType}/{agreementId}`.", "operationId": "v1.v1.offlimits-agreements.destroy", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "404": { "description": "Item with that ID doesn't exist." } }, "deprecated": true } }, "/v1/opportunities/{opportunityId}/completion": { "post": { "tags": [ "Projects" ], "summary": "Adds a completion percentage to an opportunity", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/completion` instead.\n\nIf you call `/api/opportunities/{opportunityId}/completion` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/opportunities/{opportunityId}/completion`.", "operationId": "v1.v1.opportunities.completion.store", "parameters": [ { "name": "opportunityId", "in": "path", "description": "The opportunity ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding a completion percentage to an opportunity", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.opportunities.completion.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Opportunity with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that opportunity." } }, "deprecated": true } }, "/v1/people/{personId}/import-email": { "post": { "tags": [ "People (Import Emails)" ], "summary": "Imports people email.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/import-email` instead.\n\nIf you call `/api/people/{personId}/import-email` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/people/{personId}/import-email`.", "operationId": "v1.v1..8", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.importEmailRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.importEmailResource" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/tasks/{id}/done": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's completion status.", "description": "**Deprecated.** Removed on 1 January 2027.\n\nIf you call `/api/tasks/{id}/done` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{id}/done`.", "operationId": "v1.v1.tasks.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdateDone" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/tasks/{id}/priority": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's priority.", "description": "**Deprecated.** Removed on 1 January 2027.\n\nIf you call `/api/tasks/{id}/priority` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{id}/priority`.", "operationId": "v1.v1.tasks.updateType.2", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePriority" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/tasks/{id}/pinned": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's pinned status.", "description": "**Deprecated.** Removed on 1 January 2027.\n\nIf you call `/api/tasks/{id}/pinned` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{id}/pinned`.", "operationId": "v1.v1.tasks.updateType.3", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Fetches all tasks.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks` instead.\n\nIf you call `/api/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks`.", "operationId": "v1.v1.tasks.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.done", "name": "done", "in": "query", "description": "Return only completed or active results", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue tasks", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private tasks", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned tasks", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter tasks by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Tasks" ], "summary": "Creates a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks` instead.\n\nIf you call `/api/tasks` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks`.", "operationId": "v1.v1.tasks.store", "parameters": [ { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Fetches a task by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.\n\nIf you call `/api/tasks/{taskId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{taskId}`.", "operationId": "v1.v1.tasks.show", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } } }, "type": "object" } } } }, "404": { "description": "Task with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." } }, "deprecated": true }, "put": { "tags": [ "Tasks" ], "summary": "Updates a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.\n\nIf you call `/api/tasks/{taskId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{taskId}`.", "operationId": "v1.v1.tasks.update", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Tasks" ], "summary": "Deletes a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.\n\nIf you call `/api/tasks/{taskId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/tasks/{taskId}`.", "operationId": "v1.v1.tasks.destroy", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Task with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/meetings/{meetingId}/{typeId}": { "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting's pinned status.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}/{typeId}` instead.\n\nIf you call `/api/meetings/{meetingId}/{typeId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings/{meetingId}/{typeId}`.", "operationId": "v1.v1.meetings.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Fetches all meetings.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings` instead.\n\nIf you call `/api/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings`.", "operationId": "v1.v1.meetings.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } }, { "parameter": "api.past", "name": "past", "in": "query", "description": "Return only past or upcoming meetings", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue meetings", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private meetings", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned meetings", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter meetings by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Meetings" ], "summary": "Creates a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings` instead.\n\nIf you call `/api/meetings` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings`.", "operationId": "v1.v1.meetings.store", "parameters": [ { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/meetings/{meetingId}": { "get": { "tags": [ "Meetings" ], "summary": "Fetches a meeting by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.\n\nIf you call `/api/meetings/{meetingId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings/{meetingId}`.", "operationId": "v1.v1.meetings.show", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." } }, "deprecated": true }, "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.\n\nIf you call `/api/meetings/{meetingId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings/{meetingId}`.", "operationId": "v1.v1.meetings.update", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Meetings" ], "summary": "Deletes a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.\n\nIf you call `/api/meetings/{meetingId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/meetings/{meetingId}`.", "operationId": "v1.v1.meetings.destroy", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v1/graph/connected": { "get": { "tags": [ "Meetings" ], "summary": "Fetches Microsoft Graph details on connected accounts.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/graph/connected` instead.\n\nIf you call `/api/graph/connected` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/graph/connected`.", "operationId": "v1.v1.graph.connected", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.graph" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/relationships": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationships for a particular type.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships` instead.\n\nIf you call `/api/relationships` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/relationships`.", "operationId": "v1.v1.relationships.index", "parameters": [ { "name": "id", "in": "query", "description": "The id of the model type to get relationships for.", "schema": { "type": "integer" }, "example": "123" }, { "name": "type", "in": "query", "description": "The model type to get relationships for.", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "person" }, { "name": "relatedType", "in": "query", "description": "The relationship type to be returned. Exclude to return all relationship types", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "company" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Relationships" ], "summary": "Creates a new relationship", "description": "Store a newly created resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships` instead.\n\nIf you call `/api/relationships` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/relationships`.", "operationId": "v1.v1.relationships.store", "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true } }, "/v1/relationships/{relationshipId}": { "put": { "tags": [ "Relationships" ], "summary": "Updates a relationship", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships/{relationshipId}` instead.\n\nIf you call `/api/relationships/{relationshipId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/relationships/{relationshipId}`.", "operationId": "v1.v1.relationships.update", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "delete": { "tags": [ "Relationships" ], "summary": "Deletes a relationship", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships/{relationshipId}` instead.\n\nIf you call `/api/relationships/{relationshipId}` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/relationships/{relationshipId}`.", "operationId": "v1.v1.relationships.destroy", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true } }, "/v1/relationship-labels": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationship labels.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationship-labels` instead.\n\nIf you call `/api/relationship-labels` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/relationship-labels`.", "operationId": "v1.v1.relationship-labels.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationshipLabel" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v1/me": { "get": { "tags": [ "Authentication" ], "summary": "Get authenticated user information", "description": "Returns basic information about the currently authenticated user\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/me` instead.\n\nIf you call `/api/me` without a version, you are calling this endpoint. That form is being removed too — change it to `/api/v4/me`.", "operationId": "v1.v1..9", "responses": { "200": { "description": "Successful response with user information", "content": { "application/json": { "schema": { "required": [ "id", "email", "fullName" ], "properties": { "id": { "description": "The unique identifier of the user", "type": "integer", "example": 123 }, "email": { "description": "The email address of the user", "type": "string", "format": "email", "example": "user@example.com" }, "fullName": { "description": "The full name of the user", "type": "string", "example": "John Doe" } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/search-users": { "get": { "tags": [ "Search Firm Users" ], "summary": "Fetches all users for the search firm", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/search-users` instead.", "operationId": "v2.v2.search-users.index", "parameters": [ { "name": "q", "in": "query", "description": "A query string to filter the results by name or email.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.count", "name": "count", "in": "query", "description": "Specify how many records to be returned per page.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/people/{personId}/emails": { "post": { "tags": [ "People (Emails)" ], "summary": "Adds a new email address to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails` instead.", "operationId": "v2.v2.people.emails.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/emails/{emailId}": { "put": { "tags": [ "People (Emails)" ], "summary": "Updates an email address on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails/{emailId}` instead.", "operationId": "v2.v2.people.emails.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be changed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Emails)" ], "summary": "Deletes an email address from a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/emails/{emailId}` instead.", "operationId": "v2.v2.people.emails.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be removed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v2/people/{personId}/phones": { "post": { "tags": [ "People (Phones)" ], "summary": "Adds a new phone number to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones` instead.", "operationId": "v2.v2.people.phones.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/phones/{phoneId}": { "put": { "tags": [ "People (Phones)" ], "summary": "Updates an phone number on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones/{phoneId}` instead.", "operationId": "v2.v2.people.phones.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Phones)" ], "summary": "Deletes an phone number from a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/phones/{phoneId}` instead.", "operationId": "v2.v2.people.phones.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v2/people/tags/{tagId}": { "post": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Adds tags to people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/tags/{tagId}` instead.", "operationId": "v2.v2.tags.store", "requestBody": { "description": "The body for adding tags to people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } }, "deprecated": true }, "delete": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Removes tags from people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/tags/{tagId}` instead.", "operationId": "v2.v2.tags.destroy", "requestBody": { "description": "The body for removing tags from people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } }, "deprecated": true } }, "/v2/people": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches all people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people` instead.", "operationId": "v2.v2.people.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "People (Profile)" ], "summary": "Creates a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people` instead.", "operationId": "v2.v2.people.store", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.v2.person.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches a person by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.", "operationId": "v2.v2.people.show", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person" } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } }, "deprecated": true }, "put": { "tags": [ "People (Profile)" ], "summary": "Updates a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.", "operationId": "v2.v2.people.update", "parameters": [ { "$ref": "#/components/parameters/api.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v2.person.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person" } }, "type": "object" } } } }, "422": { "description": "Person with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Profile)" ], "summary": "Deletes a person by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}` instead.", "operationId": "v2.v2.people.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } }, "deprecated": true } }, "/v2/projects": { "get": { "tags": [ "Projects" ], "summary": "Fetches all projects.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects` instead.", "operationId": "v2.v2.projects.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.project.filterOn" }, { "$ref": "#/components/parameters/api.project.fields" }, { "$ref": "#/components/parameters/api.project.exclude" }, { "$ref": "#/components/parameters/api.project.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.project.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, { "name": "isAssignment", "in": "query", "description": "By setting this parameter only assignments will be returned in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "isOpportunity", "in": "query", "description": "By setting this parameter only opportunities will be returned in the response.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Projects" ], "summary": "Creates a project", "description": "Store a newly created resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects` instead.", "operationId": "v2.v2.projects.store", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.project.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Fetches a project by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.", "operationId": "v2.v2.projects.show", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "put": { "tags": [ "Projects" ], "summary": "Updates a project", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.", "operationId": "v2.v2.projects.update", "parameters": [ { "$ref": "#/components/parameters/api.project.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.project.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "delete": { "tags": [ "Projects" ], "summary": "Deletes a project by ID", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}` instead.", "operationId": "v2.v2.projects.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that project." } }, "deprecated": true } }, "/v2/statuses/{typeId}": { "get": { "tags": [ "Status tags" ], "summary": "Fetches all status tags of a particular type.", "description": "The authorization is done in the methods as the actions are shared\nbetween the different model types.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/statuses/{typeId}` instead.", "operationId": "v2.v2.statuses.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of tag.", "required": true, "schema": { "type": "string", "enum": [ "assignment", "list", "candidate", "lead", "person", "opportunity", "client", "task", "meeting", "revenue", "invoice", "note" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/assignments/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to an assignment.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/candidates` instead.", "operationId": "v2.v2.assignments.candidates.store", "requestBody": { "description": "The body for adding candidates to assignments.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the assignment cannot be found." } }, "deprecated": true } }, "/v2/assignments/{assignmentId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}` instead.", "operationId": "v2.v2.assignments.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } }, "deprecated": true }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{assignmentId}/candidates/statuses/{tagId}` instead.", "operationId": "v2.v2.assignments.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } }, "deprecated": true } }, "/v2/projects/{projectId}/candidates": { "get": { "tags": [ "Projects (Candidates)" ], "summary": "Fetches candidates from a specific project.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/candidates` instead.", "operationId": "v2.v2.projects.candidates.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fieldsWithCandidate" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/people/notes": { "post": { "tags": [ "People (Notes)", "Notes" ], "summary": "Adds notes to one or more people.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes` instead.", "operationId": "v2.v2.", "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.note.storeRequest" }, { "properties": { "people": { "description": "An array of person IDs that will have the notes added.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } ] } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.notesUpdateResponse" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/notes/{noteId}": { "put": { "tags": [ "People (Notes)", "Notes" ], "summary": "Updates a note.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes/{noteId}` instead.", "operationId": "v2.v2..2", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Notes)", "Notes" ], "summary": "Deletes a note.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/notes/{noteId}` instead.", "operationId": "v2.v2..3", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that note." } }, "deprecated": true } }, "/v2/companies/{companyId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes` instead.", "operationId": "v2.v2.companies.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes` instead.", "operationId": "v2.v2.companies.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes` instead.", "operationId": "v2.v2.projects.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes` instead.", "operationId": "v2.v2.projects.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes` instead.", "operationId": "v2.v2.assignments.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes` instead.", "operationId": "v2.v2.assignments.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes` instead.", "operationId": "v2.v2.opportunities.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes` instead.", "operationId": "v2.v2.opportunities.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes` instead.", "operationId": "v2.v2.people.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes` instead.", "operationId": "v2.v2.people.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes` instead.", "operationId": "v2.v2.lists.notes.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes` instead.", "operationId": "v2.v2.lists.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes/{noteId}` instead.", "operationId": "v2.v2.companies.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/notes/{noteId}` instead.", "operationId": "v2.v2.companies.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes/{noteId}` instead.", "operationId": "v2.v2.projects.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/notes/{noteId}` instead.", "operationId": "v2.v2.projects.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}` instead.", "operationId": "v2.v2.assignments.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/notes/{noteId}` instead.", "operationId": "v2.v2.assignments.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes/{noteId}` instead.", "operationId": "v2.v2.opportunities.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/notes/{noteId}` instead.", "operationId": "v2.v2.opportunities.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes/{noteId}` instead.", "operationId": "v2.v2.people.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/notes/{noteId}` instead.", "operationId": "v2.v2.people.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes/{noteId}` instead.", "operationId": "v2.v2.lists.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/notes/{noteId}` instead.", "operationId": "v2.v2.lists.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/documents` instead.", "operationId": "v2.v2.companies.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/documents` instead.", "operationId": "v2.v2.projects.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/documents` instead.", "operationId": "v2.v2.assignments.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/documents` instead.", "operationId": "v2.v2.opportunities.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/documents` instead.", "operationId": "v2.v2.people.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/documents` instead.", "operationId": "v2.v2.lists.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/tasks` instead.", "operationId": "v2.v2.companies.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/projects/{projectId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/tasks` instead.", "operationId": "v2.v2.projects.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/tasks` instead.", "operationId": "v2.v2.assignments.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/tasks` instead.", "operationId": "v2.v2.opportunities.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/people/{personId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/tasks` instead.", "operationId": "v2.v2.people.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/tasks` instead.", "operationId": "v2.v2.lists.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/companies/{companyId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/meetings` instead.", "operationId": "v2.v2.companies.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/projects/{projectId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/meetings` instead.", "operationId": "v2.v2.projects.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/meetings` instead.", "operationId": "v2.v2.assignments.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/meetings` instead.", "operationId": "v2.v2.opportunities.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/people/{personId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/meetings` instead.", "operationId": "v2.v2.people.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/meetings` instead.", "operationId": "v2.v2.lists.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/companies/{companyId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.", "operationId": "v2.v2.companies.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.", "operationId": "v2.v2.companies.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/additional-info` instead.", "operationId": "v2.v2.companies.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.", "operationId": "v2.v2.projects.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.", "operationId": "v2.v2.projects.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/additional-info` instead.", "operationId": "v2.v2.projects.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.", "operationId": "v2.v2.assignments.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.", "operationId": "v2.v2.assignments.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/additional-info` instead.", "operationId": "v2.v2.assignments.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.", "operationId": "v2.v2.opportunities.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.", "operationId": "v2.v2.opportunities.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/additional-info` instead.", "operationId": "v2.v2.opportunities.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.", "operationId": "v2.v2.people.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.", "operationId": "v2.v2.people.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/additional-info` instead.", "operationId": "v2.v2.people.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.", "operationId": "v2.v2.lists.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.", "operationId": "v2.v2.lists.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/additional-info` instead.", "operationId": "v2.v2.lists.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/status/{statusId}` instead.", "operationId": "v2.v2.companies.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/status/{statusId}` instead.", "operationId": "v2.v2.projects.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/status/{statusId}` instead.", "operationId": "v2.v2.assignments.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/status/{statusId}` instead.", "operationId": "v2.v2.opportunities.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/status/{statusId}` instead.", "operationId": "v2.v2.people.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/status/{statusId}` instead.", "operationId": "v2.v2.lists.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/off-limits/agreements/companies/{companyId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/companies/{companyId}` instead.", "operationId": "v2.v2.companies.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/off-limits/agreements/people/{personId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/people/{personId}` instead.", "operationId": "v2.v2.people.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/companies/{companyId}/links": { "post": { "tags": [ "Companies (Links)" ], "summary": "Adds a new link to a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links` instead.", "operationId": "v2.v2.companies.links.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/links": { "post": { "tags": [ "People (Links)" ], "summary": "Adds a new link to a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links` instead.", "operationId": "v2.v2.people.links.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/links/{linkId}": { "put": { "tags": [ "Companies (Links)" ], "summary": "Updates a link on a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links/{linkId}` instead.", "operationId": "v2.v2.companies.links.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies (Links)" ], "summary": "Deletes a link on a company.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/links/{linkId}` instead.", "operationId": "v2.v2.companies.links.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v2/people/{personId}/links/{linkId}": { "put": { "tags": [ "People (Links)" ], "summary": "Updates a link on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links/{linkId}` instead.", "operationId": "v2.v2.people.links.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "People (Links)" ], "summary": "Deletes a link on a person.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/links/{linkId}` instead.", "operationId": "v2.v2.people.links.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true } }, "/v2/custom-fields/{typeId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves all custom fields of a particular type", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/custom-fields/{typeId}` instead.", "operationId": "v2.v2.custom-fields.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/custom-fields/{typeId}/{customFieldId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves a custom field by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/custom-fields/{typeId}/{customFieldId}` instead.", "operationId": "v2.v2.custom-fields.show", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "customFieldId", "in": "path", "description": "The custom field ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/lists": { "get": { "tags": [ "Lists" ], "summary": "Fetches all lists.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists` instead.", "operationId": "v2.v2.lists.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.list.fields" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.list" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Lists" ], "summary": "Creates a list", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists` instead.", "operationId": "v2.v2.lists.store", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/lists/{search_firm_listId}": { "get": { "tags": [ "Lists" ], "summary": "Fetches a list by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.", "operationId": "v2.v2.lists.show", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "List with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } }, "deprecated": true }, "put": { "tags": [ "Lists" ], "summary": "Updates a list", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.", "operationId": "v2.v2.lists.update", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "List with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } }, "deprecated": true }, "delete": { "tags": [ "Lists" ], "summary": "Deletes a list by ID", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{search_firm_listId}` instead.", "operationId": "v2.v2.lists.destroy", "parameters": [ { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "List with that ID doesn't exist." } }, "deprecated": true } }, "/v2/lists/{projectId}/people": { "get": { "tags": [ "Lists", "People (Lists)" ], "summary": "Fetches all people in a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people` instead.", "operationId": "v2.v2.lists.people.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.lead.status" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/lists/{projectId}/people/{personId}": { "put": { "tags": [ "Lists", "People (Lists)" ], "summary": "Add a person to a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people/{personId}` instead.", "operationId": "v2.v2.lists.people.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" }, "meta": { "properties": { "person": { "$ref": "#/components/schemas/api.v2.person" }, "updated": { "$ref": "#/components/schemas/api.listPeopleUpdateResponse" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "delete": { "tags": [ "Lists", "People (Lists)" ], "summary": "Remove a person from a list.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{projectId}/people/{personId}` instead.", "operationId": "v2.v2.lists.people.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/companies": { "get": { "tags": [ "Companies" ], "summary": "Fetches all companies.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies` instead.", "operationId": "v2.v2.companies.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned companies will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Companies" ], "summary": "Creates a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies` instead.", "operationId": "v2.v2.companies.store", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.v2.company.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.", "operationId": "v2.v2.companies.show", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Updates a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.", "operationId": "v2.v2.companies.update", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v2.company.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Deletes a company by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}` instead.", "operationId": "v2.v2.companies.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that company." } }, "deprecated": true } }, "/v2/clients/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/clients/{companyId}` instead.", "operationId": "v2.v2.client.show", "parameters": [ { "$ref": "#/components/parameters/api.company.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } }, "deprecated": true } }, "/v2/clients": { "get": { "tags": [ "Clients" ], "summary": "Fetches all clients.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/clients` instead.", "operationId": "v2.v2.clients.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned clients will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/people/{personId}/positions": { "get": { "tags": [ "People (Positions)" ], "summary": "Gets all positions for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions` instead.", "operationId": "v2.v2.people.positions.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.position.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "startDate" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person.position" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "People (Positions)" ], "summary": "Creates a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions` instead.", "operationId": "v2.v2.people.positions.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/positions/{positionId}": { "put": { "tags": [ "People (Positions)" ], "summary": "Updates a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions/{positionId}` instead.", "operationId": "v2.v2.people.positions.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The ID of the position", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Positions)" ], "summary": "Deletes a position for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/positions/{positionId}` instead.", "operationId": "v2.v2.people.positions.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The position ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Position with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that position." } }, "deprecated": true } }, "/v2/people/{personId}/education": { "get": { "tags": [ "People (Education/Qualifications)" ], "summary": "Gets all educations for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education` instead.", "operationId": "v2.v2.people.education.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.education.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "start" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "People (Education/Qualifications)" ], "summary": "Creates a education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education` instead.", "operationId": "v2.v2.people.education.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/education/{educationId}": { "put": { "tags": [ "People (Education/Qualifications)" ], "summary": "Updates an education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education/{educationId}` instead.", "operationId": "v2.v2.people.education.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The ID of the education", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } }, "deprecated": true }, "delete": { "tags": [ "People (Education/Qualifications)" ], "summary": "Deletes an education for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/education/{educationId}` instead.", "operationId": "v2.v2.people.education.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The education ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Education with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that education." } }, "deprecated": true } }, "/v2/people/{personId}/confidential": { "post": { "tags": [ "People (Confidential Details)" ], "summary": "Sets confidential details for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/confidential` instead.", "operationId": "v2.v2.people.confidential.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The confidential details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.confidential.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.confidential" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/aspirations": { "post": { "tags": [ "People (Aspirations)" ], "summary": "Sets aspiration details for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/aspirations` instead.", "operationId": "v2.v2.people.aspirations.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The aspiration details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.aspiration.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.aspiration" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/languages": { "post": { "tags": [ "People (Languages)" ], "summary": "Add a language for a person", "description": "Adds a new language or updates an existing language for a candidate.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/languages` instead.", "operationId": "v2.v2.people.languages.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The language details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.language.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.language" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/languages/{languageId}": { "delete": { "tags": [ "People (Languages)" ], "summary": "Delete a language for a person", "description": "Deletes a language for a candidate.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/languages/{languageId}` instead.", "operationId": "v2.v2.people.languages.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "languageId", "in": "path", "description": "The ID of the language", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Language with that ID doesn't exist." } }, "deprecated": true } }, "/v2/people/{personId}/current-status": { "post": { "tags": [ "People (Current Status)" ], "summary": "Sets current status for a person", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/current-status` instead.", "operationId": "v2.v2.people.current-status.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The current status body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.currentStatus.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.currentStatus" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/people/{personId}/profile-picture": { "post": { "tags": [ "People (Profile)" ], "summary": "Update a person's profile picture", "description": "Update candidate profile picture\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/profile-picture` instead.", "operationId": "v2.v2.people.profile-picture.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/api.candidate.profilePicture.storeRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/languages/codes": { "get": { "tags": [ "People (Languages)" ], "summary": "Get all language codes and names", "description": "Returns a list of all language codes and their corresponding names.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/languages/codes` instead.", "operationId": "v2.v2.languages.codes", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.language.codes" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/notes": { "get": { "tags": [ "Notes" ], "summary": "Fetches all notes", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/notes` instead.", "operationId": "v2.v2.notes.forFirm", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "name": "type", "in": "query", "description": "Filter the results by the type of parent model.", "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "query", "description": "The ID of the parent model", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.firm.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/revenues": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches all revenues.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues` instead.", "operationId": "v2.v2..4", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.revenue" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/invoices": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all invoices.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices` instead.", "operationId": "v2.v2..5", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.invoice.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.invoice.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees` instead.", "operationId": "v2.v2..6", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/percent-splits": { "get": { "tags": [ "Billing (Percent Splits)" ], "summary": "Fetches all percent splits.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/percent-splits` instead.", "operationId": "v2.v2..7", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/fixed-fees/{fixedFeeId}": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches a fixed fee by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}` instead.", "operationId": "v2.v2.fixed-fees.show", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Deletes fixed fee item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}` instead.", "operationId": "v2.v2.fixed-fees.destroy", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Fixed fee with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/fixed-fees/{fixedFeeId}/lock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Locks a fixed fee.", "description": "Lock fixed fee\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}/lock` instead.", "operationId": "v2.v2.fixed-fees.lock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/fixed-fees/{fixedFeeId}/unlock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Unlocks a fixed fee.", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/fixed-fees/{fixedFeeId}/unlock` instead.", "operationId": "v2.v2.fixed-fees.unlock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/revenues/{revenueId}": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches a revenue by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}` instead.", "operationId": "v2.v2.revenues.show", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Revenues)" ], "summary": "Deletes revenue item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}` instead.", "operationId": "v2.v2.revenues.destroy", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/revenues/{revenueId}/lock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Locks a revenue.", "description": "Lock revenue\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}/lock` instead.", "operationId": "v2.v2.revenues.lock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/revenues/{revenueId}/unlock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Unlocks a revenue.", "description": "Unlock revenue\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/revenues/{revenueId}/unlock` instead.", "operationId": "v2.v2.revenues.unlock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/invoices/{invoiceId}": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches a invoice by ID.", "description": "Display the specified resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}` instead.", "operationId": "v2.v2.invoices.show", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The invoice ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that invoice." } }, "deprecated": true }, "delete": { "tags": [ "Billing (Invoices)" ], "summary": "Deletes an invoice by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}` instead.", "operationId": "v2.v2.invoices.destroy", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/invoices/{invoiceId}/lock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Locks an invoice.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}/lock` instead.", "operationId": "v2.v2.invoices.lock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.lockInvoice" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/invoices/{invoiceId}/unlock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Unlocks an invoice.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoices/{invoiceId}/unlock` instead.", "operationId": "v2.v2.invoices.unlock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/billing": { "get": { "tags": [ "Billing" ], "summary": "Fetches billing information for an item.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing` instead.", "operationId": "v2.v2.projects.billing", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/projects/{projectId}/revenues": { "post": { "tags": [ "Billing (Revenues)" ], "summary": "Creates a revenue.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/revenues` instead.", "operationId": "v2.v2.projects.revenues.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/revenues/{revenueId}": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Updates a revenue", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/revenues/{revenueId}` instead.", "operationId": "v2.v2.projects.revenues.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "revenueId", "in": "path", "description": "The ID of the revenue", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.revenue" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/invoices": { "post": { "tags": [ "Billing (Invoices)" ], "summary": "Adds invoice to billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/invoices` instead.", "operationId": "v2.v2.projects.invoices.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/invoices/{invoiceId}": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Updates an invoice.", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/invoices/{invoiceId}` instead.", "operationId": "v2.v2.projects.invoices.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees by project ID.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees` instead.", "operationId": "v2.v2.projects.fixed-fees.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } }, "deprecated": true }, "post": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Adds new fixed fee to billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees` instead.", "operationId": "v2.v2.projects.fixed-fees.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/fixed-fees/{fixed_feeId}": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Updates a fixed fee.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/fixed-fees/{fixed_feeId}` instead.", "operationId": "v2.v2.projects.fixed-fees.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "fixed_feeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.feeSplit" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/billing/contact": { "get": { "tags": [ "Billing" ], "summary": "Fetches the project billing contact", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact` instead.", "operationId": "v2.v2.projects.billing.contact.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project or that project's billing information." } }, "deprecated": true }, "post": { "tags": [ "Billing" ], "summary": "Adds the contact to a project billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact` instead.", "operationId": "v2.v2.projects.billing.contact.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The billing contact body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.full" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/projects/{projectId}/billing/contact/{contactId}": { "delete": { "tags": [ "Billing" ], "summary": "Removes the contact from project billing.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/billing/contact/{contactId}` instead.", "operationId": "v2.v2.projects.billing.contact", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": {} } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/invoice-templates": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all the invoice templates.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/invoice-templates` instead.", "operationId": "v2.v2.invoice-templates.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoiceTemplate" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/off-limits/agreements/{modelType}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for people or companies", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}` instead.", "operationId": "v2.v2.offlimits-agreements.index", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true }, "post": { "tags": [ "Off-Limits" ], "summary": "Creates an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}` instead.", "operationId": "v2.v2.offlimits-agreements.store", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } } ], "requestBody": { "description": "The body for creating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/off-limits/agreements/{modelType}/{agreementId}": { "put": { "tags": [ "Off-Limits" ], "summary": "Updates an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}/{agreementId}` instead.", "operationId": "v2.v2.offlimits-agreements.update", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Item with that ID doesn't exist." } }, "deprecated": true }, "delete": { "tags": [ "Off-Limits" ], "summary": "Deletes an off-limits agreement for a person or a company", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/off-limits/agreements/{modelType}/{agreementId}` instead.", "operationId": "v2.v2.offlimits-agreements.destroy", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "404": { "description": "Item with that ID doesn't exist." } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/completion": { "post": { "tags": [ "Projects" ], "summary": "Adds a completion percentage to an opportunity", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/completion` instead.", "operationId": "v2.v2.opportunities.completion.store", "parameters": [ { "name": "opportunityId", "in": "path", "description": "The opportunity ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding a completion percentage to an opportunity", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.opportunities.completion.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Opportunity with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that opportunity." } }, "deprecated": true } }, "/v2/people/{personId}/import-email": { "post": { "tags": [ "People (Import Emails)" ], "summary": "Imports people email.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/import-email` instead.", "operationId": "v2.v2..8", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.importEmailRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.importEmailResource" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/tasks/{id}/done": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's completion status.", "description": "**Deprecated.** Removed on 1 January 2027.", "operationId": "v2.v2.tasks.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdateDone" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/tasks/{id}/priority": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's priority.", "description": "**Deprecated.** Removed on 1 January 2027.", "operationId": "v2.v2.tasks.updateType.2", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePriority" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/tasks/{id}/pinned": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's pinned status.", "description": "**Deprecated.** Removed on 1 January 2027.", "operationId": "v2.v2.tasks.updateType.3", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Fetches all tasks.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks` instead.", "operationId": "v2.v2.tasks.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.done", "name": "done", "in": "query", "description": "Return only completed or active results", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue tasks", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private tasks", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned tasks", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter tasks by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Tasks" ], "summary": "Creates a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks` instead.", "operationId": "v2.v2.tasks.store", "parameters": [ { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Fetches a task by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.", "operationId": "v2.v2.tasks.show", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } } }, "type": "object" } } } }, "404": { "description": "Task with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." } }, "deprecated": true }, "put": { "tags": [ "Tasks" ], "summary": "Updates a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.", "operationId": "v2.v2.tasks.update", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Tasks" ], "summary": "Deletes a task.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/tasks/{taskId}` instead.", "operationId": "v2.v2.tasks.destroy", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Task with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/meetings/{meetingId}/{typeId}": { "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting's pinned status.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}/{typeId}` instead.", "operationId": "v2.v2.meetings.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Fetches all meetings.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings` instead.", "operationId": "v2.v2.meetings.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } }, { "parameter": "api.past", "name": "past", "in": "query", "description": "Return only past or upcoming meetings", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue meetings", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private meetings", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned meetings", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter meetings by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Meetings" ], "summary": "Creates a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings` instead.", "operationId": "v2.v2.meetings.store", "parameters": [ { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/meetings/{meetingId}": { "get": { "tags": [ "Meetings" ], "summary": "Fetches a meeting by ID.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.", "operationId": "v2.v2.meetings.show", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." } }, "deprecated": true }, "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.", "operationId": "v2.v2.meetings.update", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true }, "delete": { "tags": [ "Meetings" ], "summary": "Deletes a meeting.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/meetings/{meetingId}` instead.", "operationId": "v2.v2.meetings.destroy", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } }, "deprecated": true } }, "/v2/graph/connected": { "get": { "tags": [ "Meetings" ], "summary": "Fetches Microsoft Graph details on connected accounts.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/graph/connected` instead.", "operationId": "v2.v2.graph.connected", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.graph" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/relationships": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationships for a particular type.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships` instead.", "operationId": "v2.v2.relationships.index", "parameters": [ { "name": "id", "in": "query", "description": "The id of the model type to get relationships for.", "schema": { "type": "integer" }, "example": "123" }, { "name": "type", "in": "query", "description": "The model type to get relationships for.", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "person" }, { "name": "relatedType", "in": "query", "description": "The relationship type to be returned. Exclude to return all relationship types", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "company" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } }, "deprecated": true }, "post": { "tags": [ "Relationships" ], "summary": "Creates a new relationship", "description": "Store a newly created resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships` instead.", "operationId": "v2.v2.relationships.store", "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true } }, "/v2/relationships/{relationshipId}": { "put": { "tags": [ "Relationships" ], "summary": "Updates a relationship", "description": "Update the specified resource in storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships/{relationshipId}` instead.", "operationId": "v2.v2.relationships.update", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true }, "delete": { "tags": [ "Relationships" ], "summary": "Deletes a relationship", "description": "Remove the specified resource from storage.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationships/{relationshipId}` instead.", "operationId": "v2.v2.relationships.destroy", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } }, "deprecated": true } }, "/v2/relationship-labels": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationship labels.", "description": "Display a listing of the resource.\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/relationship-labels` instead.", "operationId": "v2.v2.relationship-labels.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationshipLabel" } } }, "type": "object" } } } } }, "deprecated": true } }, "/v2/companies/{companyId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/companies/{companyId}/documents/{documentId}` instead.", "operationId": "v2.v2.companies.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/projects/{projectId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/projects/{projectId}/documents/{documentId}` instead.", "operationId": "v2.v2.projects.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/assignments/{searchFirmBriefId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/assignments/{searchFirmBriefId}/documents/{documentId}` instead.", "operationId": "v2.v2.assignments.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/opportunities/{opportunityId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/opportunities/{opportunityId}/documents/{documentId}` instead.", "operationId": "v2.v2.opportunities.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/people/{personId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/people/{personId}/documents/{documentId}` instead.", "operationId": "v2.v2.people.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/lists/{searchFirmListId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "description": "**Deprecated.** Removed on 1 January 2027. Use `/api/v4/lists/{searchFirmListId}/documents/{documentId}` instead.", "operationId": "v2.v2.lists.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } }, "deprecated": true } }, "/v2/me": { "get": { "tags": [ "Authentication" ], "summary": "Get authenticated user information", "description": "Returns basic information about the currently authenticated user\n\n**Deprecated.** Removed on 1 January 2027. Use `/api/v4/me` instead.", "operationId": "v2.v2..9", "responses": { "200": { "description": "Successful response with user information", "content": { "application/json": { "schema": { "required": [ "id", "email", "fullName" ], "properties": { "id": { "description": "The unique identifier of the user", "type": "integer", "example": 123 }, "email": { "description": "The email address of the user", "type": "string", "format": "email", "example": "user@example.com" }, "fullName": { "description": "The full name of the user", "type": "string", "example": "John Doe" } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "deprecated": true } }, "/v3/search-users": { "get": { "tags": [ "Search Firm Users" ], "summary": "Fetches all users for the search firm", "operationId": "v3.v3.search-users.index", "parameters": [ { "name": "q", "in": "query", "description": "A query string to filter the results by name or email.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.count", "name": "count", "in": "query", "description": "Specify how many records to be returned per page.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } } }, "type": "object" } } } } } } }, "/v3/people/{personId}/emails": { "post": { "tags": [ "People (Emails)" ], "summary": "Adds a new email address to a person.", "operationId": "v3.v3.people.emails.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/emails/{emailId}": { "put": { "tags": [ "People (Emails)" ], "summary": "Updates an email address on a person.", "operationId": "v3.v3.people.emails.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be changed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Emails)" ], "summary": "Deletes an email address from a person.", "operationId": "v3.v3.people.emails.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be removed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v3/people/{personId}/phones": { "post": { "tags": [ "People (Phones)" ], "summary": "Adds a new phone number to a person.", "operationId": "v3.v3.people.phones.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/phones/{phoneId}": { "put": { "tags": [ "People (Phones)" ], "summary": "Updates an phone number on a person.", "operationId": "v3.v3.people.phones.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Phones)" ], "summary": "Deletes an phone number from a person.", "operationId": "v3.v3.people.phones.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v3/people/tags/{tagId}": { "post": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Adds tags to people.", "operationId": "v3.v3.tags.store", "requestBody": { "description": "The body for adding tags to people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } } }, "delete": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Removes tags from people.", "operationId": "v3.v3.tags.destroy", "requestBody": { "description": "The body for removing tags from people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } } } }, "/v3/people": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches all people.", "operationId": "v3.v3.people.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v3.person.fields" }, { "$ref": "#/components/parameters/api.v3.person.exclude" }, { "$ref": "#/components/parameters/api.v3.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "People (Profile)" ], "summary": "Creates a person.", "operationId": "v3.v3.people.store", "parameters": [ { "$ref": "#/components/parameters/api.v3.person.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.person.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.person" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches a person by ID.", "operationId": "v3.v3.people.show", "parameters": [ { "$ref": "#/components/parameters/api.v3.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.person" } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } } }, "put": { "tags": [ "People (Profile)" ], "summary": "Updates a person.", "operationId": "v3.v3.people.update", "parameters": [ { "$ref": "#/components/parameters/api.v3.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.person.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.person" } }, "type": "object" } } } }, "422": { "description": "Person with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } } }, "delete": { "tags": [ "People (Profile)" ], "summary": "Deletes a person by ID.", "operationId": "v3.v3.people.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v3/projects": { "get": { "tags": [ "Projects" ], "summary": "Fetches all projects.", "operationId": "v3.v3.projects.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.project.filterOn" }, { "$ref": "#/components/parameters/api.project.fields" }, { "$ref": "#/components/parameters/api.project.exclude" }, { "$ref": "#/components/parameters/api.project.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.project.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, { "name": "isAssignment", "in": "query", "description": "By setting this parameter only assignments will be returned in the response." }, { "name": "isOpportunity", "in": "query", "description": "By setting this parameter only opportunities will be returned in the response." }, { "name": "isList", "in": "query", "description": "By setting this parameter only list will be returned in the response." } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Creates a project", "description": "Store a newly created resource in storage.", "operationId": "v3.v3.projects.store", "requestBody": { "$ref": "#/components/requestBodies/api.v3.project.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.project.default" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Fetches a project by ID", "operationId": "v3.v3.projects.show", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.project.fields" }, { "$ref": "#/components/parameters/api.project.exclude" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "put": { "tags": [ "Projects" ], "summary": "Updates a project", "description": "Update the specified resource in storage.", "operationId": "v3.v3.projects.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.project.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.project.default" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "delete": { "tags": [ "Projects" ], "summary": "Archive or delete a project", "description": "Archive or permanently delete a project.", "operationId": "v3.v3.projects.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "force", "in": "query", "description": "Permanently delete the project", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "Project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that project." } } } }, "/v3/statuses/{typeId}": { "get": { "tags": [ "Status tags" ], "summary": "Fetches all status tags of a particular type.", "description": "The authorization is done in the methods as the actions are shared\nbetween the different model types.", "operationId": "v3.v3.statuses.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of tag.", "required": true, "schema": { "type": "string", "enum": [ "assignment", "list", "candidate", "lead", "person", "opportunity", "client", "task", "meeting", "revenue", "invoice", "note" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } } } } } } }, "/v3/assignments/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to an assignment.", "operationId": "v3.v3.assignments.candidates.store", "requestBody": { "description": "The body for adding candidates to assignments.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the assignment cannot be found." } } } }, "/v3/assignments/{assignmentId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "operationId": "v3.v3.assignments.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "operationId": "v3.v3.assignments.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } } } }, "/v3/projects/{projectId}/candidates": { "get": { "tags": [ "Projects (Candidates)" ], "summary": "Fetches candidates from a specific project.", "operationId": "v3.v3.projects.candidates.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v3.person.fieldsWithCandidate" }, { "$ref": "#/components/parameters/api.v3.person.exclude" }, { "$ref": "#/components/parameters/api.v3.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes a project candidate by ID.", "operationId": "v3.v3.projects.candidates.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v3/people/notes": { "post": { "tags": [ "People (Notes)", "Notes" ], "summary": "Adds notes to one or more people.", "operationId": "v3.v3.", "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.note.storeRequest" }, { "properties": { "people": { "description": "An array of person IDs that will have the notes added.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } ] } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.notesUpdateResponse" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/notes/{noteId}": { "put": { "tags": [ "People (Notes)", "Notes" ], "summary": "Updates a note.", "operationId": "v3.v3..2", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Notes)", "Notes" ], "summary": "Deletes a note.", "operationId": "v3.v3..3", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that note." } } } }, "/v3/companies/{companyId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.companies.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.companies.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.projects.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.projects.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/assignments/{searchFirmBriefId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.assignments.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.assignments.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/opportunities/{opportunityId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.opportunities.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.opportunities.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.people.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.people.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{searchFirmListId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v3.v3.lists.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v3.v3.lists.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.companies.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.companies.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.projects.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.projects.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/assignments/{searchFirmBriefId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.assignments.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.assignments.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/opportunities/{opportunityId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.opportunities.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.opportunities.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.people.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.people.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{searchFirmListId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v3.v3.lists.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v3.v3.lists.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.companies.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.projects.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/assignments/{searchFirmBriefId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.assignments.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/opportunities/{opportunityId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.opportunities.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.people.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{searchFirmListId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v3.v3.lists.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.companies.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/projects/{projectId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.projects.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/assignments/{searchFirmBriefId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.assignments.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/opportunities/{opportunityId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.opportunities.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/people/{personId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.people.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/lists/{searchFirmListId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v3.v3.lists.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/companies/{companyId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.companies.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/projects/{projectId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.projects.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/assignments/{searchFirmBriefId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.assignments.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/opportunities/{opportunityId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.opportunities.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/people/{personId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.people.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/lists/{searchFirmListId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v3.v3.lists.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/companies/{companyId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.companies.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.companies.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.companies.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.projects.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.projects.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.projects.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/assignments/{searchFirmBriefId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.assignments.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.assignments.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.assignments.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/opportunities/{opportunityId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.opportunities.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.opportunities.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.opportunities.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.people.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.people.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.people.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{searchFirmListId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v3.v3.lists.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v3.v3.lists.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v3.v3.lists.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.companies.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.projects.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/assignments/{searchFirmBriefId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.assignments.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/opportunities/{opportunityId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.opportunities.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.people.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{searchFirmListId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v3.v3.lists.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/off-limits/agreements/companies/{companyId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "operationId": "v3.v3.companies.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/off-limits/agreements/people/{personId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "operationId": "v3.v3.people.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/companies/{companyId}/links": { "post": { "tags": [ "Companies (Links)" ], "summary": "Adds a new link to a company.", "operationId": "v3.v3.companies.links.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/links": { "post": { "tags": [ "People (Links)" ], "summary": "Adds a new link to a person.", "operationId": "v3.v3.people.links.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/links/{linkId}": { "put": { "tags": [ "Companies (Links)" ], "summary": "Updates a link on a company.", "operationId": "v3.v3.companies.links.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Companies (Links)" ], "summary": "Deletes a link on a company.", "operationId": "v3.v3.companies.links.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v3/people/{personId}/links/{linkId}": { "put": { "tags": [ "People (Links)" ], "summary": "Updates a link on a person.", "operationId": "v3.v3.people.links.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Links)" ], "summary": "Deletes a link on a person.", "operationId": "v3.v3.people.links.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v3/custom-fields/{typeId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves all custom fields of a particular type", "operationId": "v3.v3.custom-fields.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/custom-fields/{typeId}/{customFieldId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves a custom field by ID", "operationId": "v3.v3.custom-fields.show", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "customFieldId", "in": "path", "description": "The custom field ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/lists": { "get": { "tags": [ "Lists" ], "summary": "Fetches all lists.", "operationId": "v3.v3.lists.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.list.fields" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.list" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Lists" ], "summary": "Creates a list", "operationId": "v3.v3.lists.store", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/lists/{search_firm_listId}": { "get": { "tags": [ "Lists" ], "summary": "Fetches a list by ID", "operationId": "v3.v3.lists.show", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "List with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } } }, "put": { "tags": [ "Lists" ], "summary": "Updates a list", "operationId": "v3.v3.lists.update", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "List with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } } }, "delete": { "tags": [ "Lists" ], "summary": "Deletes a list by ID", "description": "Remove the specified resource from storage.", "operationId": "v3.v3.lists.destroy", "parameters": [ { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "List with that ID doesn't exist." } } } }, "/v3/lists/{projectId}/people": { "get": { "tags": [ "Lists", "People (Lists)" ], "summary": "Fetches all people in a list.", "operationId": "v3.v3.lists.people.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.lead.status" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/lists/{projectId}/people/{personId}": { "put": { "tags": [ "Lists", "People (Lists)" ], "summary": "Add a person to a list.", "operationId": "v3.v3.lists.people.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" }, "meta": { "properties": { "person": { "$ref": "#/components/schemas/api.v2.person" }, "updated": { "$ref": "#/components/schemas/api.listPeopleUpdateResponse" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "delete": { "tags": [ "Lists", "People (Lists)" ], "summary": "Remove a person from a list.", "operationId": "v3.v3.lists.people.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/companies": { "get": { "tags": [ "Companies" ], "summary": "Fetches all companies.", "operationId": "v3.v3.companies.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned companies will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Creates a company", "operationId": "v3.v3.companies.store", "requestBody": { "$ref": "#/components/requestBodies/api.v3.company.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "operationId": "v3.v3.companies.show", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } }, "put": { "tags": [ "Companies" ], "summary": "Updates a company", "operationId": "v3.v3.companies.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.company.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } }, "delete": { "tags": [ "Companies" ], "summary": "Deletes a company by ID", "operationId": "v3.v3.companies.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that company." } } } }, "/v3/clients/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "operationId": "v3.v3.client.show", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } } }, "/v3/clients": { "get": { "tags": [ "Clients" ], "summary": "Fetches all clients.", "operationId": "v3.v3.clients.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.company.fields" }, { "$ref": "#/components/parameters/api.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned clients will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/people/{personId}/positions": { "get": { "tags": [ "People (Positions)" ], "summary": "Gets all positions for a person", "operationId": "v3.v3.people.positions.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.position.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "startDate" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person.position" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "People (Positions)" ], "summary": "Creates a position for a person", "operationId": "v3.v3.people.positions.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/positions/{positionId}": { "put": { "tags": [ "People (Positions)" ], "summary": "Updates a position for a person", "operationId": "v3.v3.people.positions.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The ID of the position", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } }, "delete": { "tags": [ "People (Positions)" ], "summary": "Deletes a position for a person", "operationId": "v3.v3.people.positions.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The position ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Position with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that position." } } } }, "/v3/people/{personId}/education": { "get": { "tags": [ "People (Education/Qualifications)" ], "summary": "Gets all educations for a person", "operationId": "v3.v3.people.education.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.education.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "start" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "People (Education/Qualifications)" ], "summary": "Creates a education for a person", "operationId": "v3.v3.people.education.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/education/{educationId}": { "put": { "tags": [ "People (Education/Qualifications)" ], "summary": "Updates an education for a person", "operationId": "v3.v3.people.education.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The ID of the education", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } }, "delete": { "tags": [ "People (Education/Qualifications)" ], "summary": "Deletes an education for a person", "operationId": "v3.v3.people.education.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The education ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Education with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that education." } } } }, "/v3/people/{personId}/confidential": { "post": { "tags": [ "People (Confidential Details)" ], "summary": "Sets confidential details for a person", "operationId": "v3.v3.people.confidential.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The confidential details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.confidential.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.confidential" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/aspirations": { "post": { "tags": [ "People (Aspirations)" ], "summary": "Sets aspiration details for a person", "operationId": "v3.v3.people.aspirations.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The aspiration details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.aspiration.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.aspiration" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/languages": { "post": { "tags": [ "People (Languages)" ], "summary": "Add a language for a person", "description": "Adds a new language or updates an existing language for a candidate.", "operationId": "v3.v3.people.languages.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The language details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.language.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.language" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/languages/{languageId}": { "delete": { "tags": [ "People (Languages)" ], "summary": "Delete a language for a person", "description": "Deletes a language for a candidate.", "operationId": "v3.v3.people.languages.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "languageId", "in": "path", "description": "The ID of the language", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Language with that ID doesn't exist." } } } }, "/v3/people/{personId}/current-status": { "post": { "tags": [ "People (Current Status)" ], "summary": "Sets current status for a person", "operationId": "v3.v3.people.current-status.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The current status body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.currentStatus.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.currentStatus" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/people/{personId}/profile-picture": { "post": { "tags": [ "People (Profile)" ], "summary": "Update a person's profile picture", "description": "Update candidate profile picture", "operationId": "v3.v3.people.profile-picture.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/api.candidate.profilePicture.storeRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/languages/codes": { "get": { "tags": [ "People (Languages)" ], "summary": "Get all language codes and names", "description": "Returns a list of all language codes and their corresponding names.", "operationId": "v3.v3.languages.codes", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.language.codes" } } }, "type": "object" } } } } } } }, "/v3/notes": { "get": { "tags": [ "Notes" ], "summary": "Fetches all notes", "operationId": "v3.v3.notes.forFirm", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "name": "type", "in": "query", "description": "Filter the results by the type of parent model.", "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "query", "description": "The ID of the parent model", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.firm.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/revenues": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches all revenues.", "operationId": "v3.v3..4", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/invoices": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all invoices.", "operationId": "v3.v3..5", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.invoice.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.invoice.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees.", "operationId": "v3.v3..6", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/percent-splits": { "get": { "tags": [ "Billing (Percent Splits)" ], "summary": "Fetches all percent splits.", "operationId": "v3.v3..7", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v3/fixed-fees/{fixedFeeId}": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches a fixed fee by ID.", "description": "Display the specified resource.", "operationId": "v3.v3.fixed-fees.show", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "delete": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Deletes fixed fee item.", "operationId": "v3.v3.fixed-fees.destroy", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Fixed fee with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/fixed-fees/{fixedFeeId}/lock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Locks a fixed fee.", "description": "Lock fixed fee", "operationId": "v3.v3.fixed-fees.lock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/fixed-fees/{fixedFeeId}/unlock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Unlocks a fixed fee.", "description": "Update the specified resource in storage.", "operationId": "v3.v3.fixed-fees.unlock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/revenues/{revenueId}": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches a revenue by ID.", "description": "Display the specified resource.", "operationId": "v3.v3.revenues.show", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.v3.revenue.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "delete": { "tags": [ "Billing (Revenues)" ], "summary": "Deletes revenue item.", "operationId": "v3.v3.revenues.destroy", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/revenues/{revenueId}/lock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Locks a revenue.", "description": "Lock revenue", "operationId": "v3.v3.revenues.lock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "type": "object" } } } } } } }, "/v3/revenues/{revenueId}/unlock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Unlocks a revenue.", "description": "Unlock revenue", "operationId": "v3.v3.revenues.unlock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "type": "object" } } } } } } }, "/v3/invoices/{invoiceId}": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches a invoice by ID.", "description": "Display the specified resource.", "operationId": "v3.v3.invoices.show", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The invoice ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.v3.invoice.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that invoice." } } }, "delete": { "tags": [ "Billing (Invoices)" ], "summary": "Deletes an invoice by ID.", "operationId": "v3.v3.invoices.destroy", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/invoices/{invoiceId}/lock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Locks an invoice.", "operationId": "v3.v3.invoices.lock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.lockInvoice" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "type": "object" } } } } } } }, "/v3/invoices/{invoiceId}/unlock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Unlocks an invoice.", "operationId": "v3.v3.invoices.unlock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "type": "object" } } } } } } }, "/v3/projects/{projectId}/billing": { "get": { "tags": [ "Billing" ], "summary": "Fetches billing information for an item.", "operationId": "v3.v3.projects.billing", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/projects/{projectId}/revenues": { "post": { "tags": [ "Billing (Revenues)" ], "summary": "Creates a revenue.", "operationId": "v3.v3.projects.revenues.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/revenues/{revenueId}": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Updates a revenue", "operationId": "v3.v3.projects.revenues.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "revenueId", "in": "path", "description": "The ID of the revenue", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/invoices": { "post": { "tags": [ "Billing (Invoices)" ], "summary": "Adds invoice to billing.", "operationId": "v3.v3.projects.invoices.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/invoices/{invoiceId}": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Updates an invoice.", "description": "Update the specified resource in storage.", "operationId": "v3.v3.projects.invoices.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees by project ID.", "description": "Display a listing of the resource.", "operationId": "v3.v3.projects.fixed-fees.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "post": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Adds new fixed fee to billing.", "operationId": "v3.v3.projects.fixed-fees.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/fixed-fees/{fixed_feeId}": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Updates a fixed fee.", "operationId": "v3.v3.projects.fixed-fees.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "fixed_feeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/billing/contact": { "get": { "tags": [ "Billing" ], "summary": "Fetches the project billing contact", "operationId": "v3.v3.projects.billing.contact.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project or that project's billing information." } } }, "post": { "tags": [ "Billing" ], "summary": "Adds the contact to a project billing.", "operationId": "v3.v3.projects.billing.contact.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The billing contact body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.billing.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.full" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/billing/contact/{contactId}": { "delete": { "tags": [ "Billing" ], "summary": "Removes the contact from project billing.", "operationId": "v3.v3.projects.billing.contact", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": {} } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/invoice-templates": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all the invoice templates.", "description": "Display a listing of the resource.", "operationId": "v3.v3.invoice-templates.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoiceTemplate" } } }, "type": "object" } } } } } } }, "/v3/off-limits/agreements/{modelType}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for people or companies", "operationId": "v3.v3.offlimits-agreements.index", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Off-Limits" ], "summary": "Creates an off-limits agreement for a person or a company", "operationId": "v3.v3.offlimits-agreements.store", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } } ], "requestBody": { "description": "The body for creating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/off-limits/agreements/{modelType}/{agreementId}": { "put": { "tags": [ "Off-Limits" ], "summary": "Updates an off-limits agreement for a person or a company", "operationId": "v3.v3.offlimits-agreements.update", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Item with that ID doesn't exist." } } }, "delete": { "tags": [ "Off-Limits" ], "summary": "Deletes an off-limits agreement for a person or a company", "operationId": "v3.v3.offlimits-agreements.destroy", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "404": { "description": "Item with that ID doesn't exist." } } } }, "/v3/opportunities/{opportunityId}/completion": { "post": { "tags": [ "Projects" ], "summary": "Adds a completion percentage to an opportunity", "operationId": "v3.v3.opportunities.completion.store", "parameters": [ { "name": "opportunityId", "in": "path", "description": "The opportunity ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding a completion percentage to an opportunity", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.opportunities.completion.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Opportunity with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that opportunity." } } } }, "/v3/people/{personId}/import-email": { "post": { "tags": [ "People (Import Emails)" ], "summary": "Imports people email.", "operationId": "v3.v3..8", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.importEmailRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.importEmailResource" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/tasks/{id}/done": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's completion status.", "operationId": "v3.v3.tasks.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v3.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdateDone" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/tasks/{id}/priority": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's priority.", "operationId": "v3.v3.tasks.updateType.2", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePriority" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/tasks/{id}/pinned": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's pinned status.", "operationId": "v3.v3.tasks.updateType.3", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Fetches all tasks.", "operationId": "v3.v3.tasks.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.done", "name": "done", "in": "query", "description": "Return only completed or active results", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue tasks", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private tasks", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned tasks", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter tasks by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } }, { "parameter": "api.v3.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Creates a task.", "operationId": "v3.v3.tasks.store", "parameters": [ { "parameter": "api.v3.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.task" } } } }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Fetches a task by ID.", "operationId": "v3.v3.tasks.show", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v3.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task" } } }, "type": "object" } } } }, "404": { "description": "Task with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." } } }, "put": { "tags": [ "Tasks" ], "summary": "Updates a task.", "operationId": "v3.v3.tasks.update", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v3.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.taskRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Deletes a task.", "operationId": "v3.v3.tasks.destroy", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Task with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/meetings/{meetingId}/{typeId}": { "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting's pinned status.", "operationId": "v3.v3.meetings.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Fetches all meetings.", "operationId": "v3.v3.meetings.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } }, { "parameter": "api.past", "name": "past", "in": "query", "description": "Return only past or upcoming meetings", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue meetings", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private meetings", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned meetings", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter meetings by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Meetings" ], "summary": "Creates a meeting.", "operationId": "v3.v3.meetings.store", "parameters": [ { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting" } } } }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/meetings/{meetingId}": { "get": { "tags": [ "Meetings" ], "summary": "Fetches a meeting by ID.", "operationId": "v3.v3.meetings.show", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." } } }, "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting.", "operationId": "v3.v3.meetings.update", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.meetingRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Meetings" ], "summary": "Deletes a meeting.", "operationId": "v3.v3.meetings.destroy", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/graph/connected": { "get": { "tags": [ "Meetings" ], "summary": "Fetches Microsoft Graph details on connected accounts.", "operationId": "v3.v3.graph.connected", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.graph" } } }, "type": "object" } } } } } } }, "/v3/relationships": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationships for a particular type.", "description": "Display a listing of the resource.", "operationId": "v3.v3.relationships.index", "parameters": [ { "name": "id", "in": "query", "description": "The id of the model type to get relationships for.", "schema": { "type": "integer" }, "example": "123" }, { "name": "type", "in": "query", "description": "The model type to get relationships for.", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "person" }, { "name": "relatedType", "in": "query", "description": "The relationship type to be returned. Exclude to return all relationship types", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "company" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Relationships" ], "summary": "Creates a new relationship", "description": "Store a newly created resource in storage.", "operationId": "v3.v3.relationships.store", "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v3/relationships/{relationshipId}": { "put": { "tags": [ "Relationships" ], "summary": "Updates a relationship", "description": "Update the specified resource in storage.", "operationId": "v3.v3.relationships.update", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "delete": { "tags": [ "Relationships" ], "summary": "Deletes a relationship", "description": "Remove the specified resource from storage.", "operationId": "v3.v3.relationships.destroy", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v3/relationship-labels": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationship labels.", "description": "Display a listing of the resource.", "operationId": "v3.v3.relationship-labels.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationshipLabel" } } }, "type": "object" } } } } } } }, "/v3/companies/{companyId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.companies.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/projects/{projectId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.projects.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/assignments/{searchFirmBriefId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.assignments.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/opportunities/{opportunityId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.opportunities.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/people/{personId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.people.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/lists/{searchFirmListId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v3.v3.lists.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v3/projects/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to a project.", "operationId": "v3.v3.projects.candidates.store", "requestBody": { "description": "The body for adding candidates to projects.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.default.api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the project cannot be found." } } } }, "/v3/projects/{projectId}/convert": { "put": { "tags": [ "Projects" ], "summary": "Convert a project from one type to another", "operationId": "v3.v3.project.convert", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "convert", "in": "query", "description": "Converted Type", "required": true, "schema": { "type": "string", "minimum": 1, "enum": [ "assignment", "opportunity", "list" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } }, "422": { "description": "Project with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v3/projects/{projectId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "operationId": "v3.v3.projects.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The project, people, or tags specified do not exist." } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "operationId": "v3.v3.projects.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The project, people, or tags specified do not exist." } } } }, "/v3/projects/{projectId}/completion": { "put": { "tags": [ "Projects" ], "summary": "Updates the completion percentage on a project", "operationId": "v3.v3.project.completion", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating a completion percentage to an project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.completion.updateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } } }, "/v3/projects/{projectId}/actions": { "get": { "tags": [ "Projects" ], "summary": "Fetches all Actions from a particular Project.", "operationId": "v3.v3.projects.actions.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.project.actions" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } }, "put": { "tags": [ "Projects" ], "summary": "Update Actions", "operationId": "v3.v3.projects.actions.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding Actions to a project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.action.update" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.project.actions" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } } }, "/v3/companies/{companyId}/consultants": { "get": { "tags": [ "Companies" ], "summary": "Fetches all consultants belonging to a company.", "operationId": "v3.v3.companies.consultants.index", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds a consultant to a company.", "operationId": "v3.v3.companies.consultants.store", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.consultant.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.search.user" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/consultants": { "get": { "tags": [ "Projects" ], "summary": "Fetches all consultants belonging to a project.", "operationId": "v3.v3.projects.consultants.index", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds a consultant to a project.", "operationId": "v3.v3.projects.consultants.store", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.consultant.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.search.user" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/consultants/{consultantId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes a consultant from a company", "operationId": "v3.v3.companies.consultants.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "consultantId", "in": "path", "description": "The consultant ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/projects/{projectId}/consultants/{consultantId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes a consultant from a project", "operationId": "v3.v3.projects.consultants.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "consultantId", "in": "path", "description": "The consultant ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/companies/{companyId}/office-groups": { "get": { "tags": [ "Companies" ], "summary": "Fetches all office groups belonging to a company.", "operationId": "v3.v3.companies.office-groups.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds an office group to a company.", "operationId": "v3.v3.companies.office-groups.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.officeGroup.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.officeGroup" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/office-groups": { "get": { "tags": [ "Projects" ], "summary": "Fetches all office groups belonging to a project.", "operationId": "v3.v3.projects.office-groups.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds an office group to a project.", "operationId": "v3.v3.projects.office-groups.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.officeGroup.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.officeGroup" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/office-groups/{officeGroupId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes an office group from a company", "operationId": "v3.v3.companies.office-groups.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "officeGroupId", "in": "path", "description": "The office group ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/projects/{projectId}/office-groups/{officeGroupId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes an office group from a project", "operationId": "v3.v3.projects.office-groups.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "officeGroupId", "in": "path", "description": "The office group ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/companies/{companyId}/regions": { "get": { "tags": [ "Companies" ], "summary": "Fetches all regions belonging to a company.", "operationId": "v3.v3.companies.regions.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds a region to a company.", "operationId": "v3.v3.companies.regions.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.region.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.region" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/projects/{projectId}/regions": { "get": { "tags": [ "Projects" ], "summary": "Fetches all regions belonging to a project.", "operationId": "v3.v3.projects.regions.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds a region to a project.", "operationId": "v3.v3.projects.regions.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.region.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.region" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v3/companies/{companyId}/regions/{regionId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes a region from a company", "operationId": "v3.v3.companies.regions.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "regionId", "in": "path", "description": "The region ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/projects/{projectId}/regions/{regionId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes a region from a project", "operationId": "v3.v3.projects.regions.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "regionId", "in": "path", "description": "The region ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v3/projects/{projectId}/contacts": { "get": { "tags": [ "Projects (Contacts)" ], "summary": "Fetches contacts from a specific project.", "operationId": "v3.v3.model.contacts.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.person.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v3.person.fields" }, { "$ref": "#/components/parameters/api.v3.person.exclude" }, { "$ref": "#/components/parameters/api.v3.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects (Contacts)" ], "summary": "Adds a person as a contact to a project.", "operationId": "v3.v3.model.contacts.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding contacts to projects.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.projectContactStoreRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.person" } } } }, "404": { "description": "The people or the project cannot be found." } } } }, "/v3/projects/{projectId}/contacts/{contactId}": { "delete": { "tags": [ "Projects (Contacts)" ], "summary": "Removes a person as a contact from a project.", "operationId": "v3.v3.model.contacts.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The contact ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person or project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v3/projects-increment": { "get": { "tags": [ "Projects" ], "summary": "Fetches the next available project IDs if you have automatic numbering enabled.", "operationId": "v3.v3..9", "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.automaticNumber" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have automatic project ID numbering enabled." } } } }, "/v3/me": { "get": { "tags": [ "Authentication" ], "summary": "Get authenticated user information", "description": "Returns basic information about the currently authenticated user", "operationId": "v3.v3..10", "responses": { "200": { "description": "Successful response with user information", "content": { "application/json": { "schema": { "required": [ "id", "email", "fullName" ], "properties": { "id": { "description": "The unique identifier of the user", "type": "integer", "example": 123 }, "email": { "description": "The email address of the user", "type": "string", "format": "email", "example": "user@example.com" }, "fullName": { "description": "The full name of the user", "type": "string", "example": "John Doe" } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } } } }, "/v4/search-users": { "get": { "tags": [ "Search Firm Users" ], "summary": "Fetches all users for the search firm", "operationId": "v4.v4.search-users.index", "parameters": [ { "name": "q", "in": "query", "description": "A query string to filter the results by name or email.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.count", "name": "count", "in": "query", "description": "Specify how many records to be returned per page.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } } }, "type": "object" } } } } } } }, "/v4/people/{personId}/emails": { "post": { "tags": [ "People (Emails)" ], "summary": "Adds a new email address to a person.", "operationId": "v4.v4.people.emails.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/emails/{emailId}": { "put": { "tags": [ "People (Emails)" ], "summary": "Updates an email address on a person.", "operationId": "v4.v4.people.emails.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be changed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "requestBody": { "description": "The body for creating emails.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.emailStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.email" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Emails)" ], "summary": "Deletes an email address from a person.", "operationId": "v4.v4.people.emails.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "emailId", "in": "path", "description": "The ID of the email to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "email", "in": "query", "description": "The old email that should be removed. Can be used instead of the `emailId` in the url.", "required": false, "schema": { "type": "string", "example": "me@example.com" } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v4/people/{personId}/phones": { "post": { "tags": [ "People (Phones)" ], "summary": "Adds a new phone number to a person.", "operationId": "v4.v4.people.phones.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/phones/{phoneId}": { "put": { "tags": [ "People (Phones)" ], "summary": "Updates an phone number on a person.", "operationId": "v4.v4.people.phones.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating phone numbers.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.phoneStoreRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.phone" } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Phones)" ], "summary": "Deletes an phone number from a person.", "operationId": "v4.v4.people.phones.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "phoneId", "in": "path", "description": "The ID of the phone number to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v4/people/tags/{tagId}": { "post": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Adds tags to people.", "operationId": "v4.v4.tags.store", "requestBody": { "description": "The body for adding tags to people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } } }, "delete": { "tags": [ "People (Status tags)", "Status tags" ], "summary": "Removes tags from people.", "operationId": "v4.v4.tags.destroy", "requestBody": { "description": "The body for removing tags from people.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.tagsUpdateResponse" } } } }, "404": { "description": "The people or tags specified do not exist." } } } }, "/v4/people": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches all people.", "operationId": "v4.v4.people.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.v4.person.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v4.person.fields" }, { "$ref": "#/components/parameters/api.v4.person.exclude" }, { "$ref": "#/components/parameters/api.v4.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "People (Profile)" ], "summary": "Creates a person.", "operationId": "v4.v4.people.store", "parameters": [ { "$ref": "#/components/parameters/api.v4.person.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.person.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.person" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}": { "get": { "tags": [ "People (Profile)" ], "summary": "Fetches a person by ID.", "operationId": "v4.v4.people.show", "parameters": [ { "$ref": "#/components/parameters/api.v4.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.person" } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } } }, "put": { "tags": [ "People (Profile)" ], "summary": "Updates a person.", "operationId": "v4.v4.people.update", "parameters": [ { "$ref": "#/components/parameters/api.v4.person.fields" }, { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.person.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.person" } }, "type": "object" } } } }, "422": { "description": "Person with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." } } }, "delete": { "tags": [ "People (Profile)" ], "summary": "Deletes a person by ID.", "operationId": "v4.v4.people.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v4/projects": { "get": { "tags": [ "Projects" ], "summary": "Fetches all projects.", "operationId": "v4.v4.projects.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.v4.project.filterOn" }, { "$ref": "#/components/parameters/api.v4.project.fields" }, { "$ref": "#/components/parameters/api.v4.project.exclude" }, { "$ref": "#/components/parameters/api.project.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.project.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, { "name": "isAssignment", "in": "query", "description": "By setting this parameter only assignments will be returned in the response." }, { "name": "isOpportunity", "in": "query", "description": "By setting this parameter only opportunities will be returned in the response." }, { "name": "isList", "in": "query", "description": "By setting this parameter only list will be returned in the response." } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Creates a project", "description": "Store a newly created resource in storage.", "operationId": "v4.v4.projects.store", "requestBody": { "$ref": "#/components/requestBodies/api.v4.project.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.default" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Fetches a project by ID", "operationId": "v4.v4.projects.show", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.v4.project.fields" }, { "$ref": "#/components/parameters/api.v4.project.exclude" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "put": { "tags": [ "Projects" ], "summary": "Updates a project", "description": "Update the specified resource in storage.", "operationId": "v4.v4.projects.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.project.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.default" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "delete": { "tags": [ "Projects" ], "summary": "Archive or delete a project", "description": "Archive or permanently delete a project.", "operationId": "v4.v4.projects.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "force", "in": "query", "description": "Permanently delete the project", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "Project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that project." } } } }, "/v4/projects/{projectId}/restore": { "put": { "tags": [ "Projects" ], "summary": "Restore Archived project by ID", "description": "restore the specified resource from storage.", "operationId": "v4.v4.projects.restore", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "Project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that project." } } } }, "/v4/statuses/{typeId}": { "get": { "tags": [ "Status tags" ], "summary": "Fetches all status tags of a particular type.", "description": "The authorization is done in the methods as the actions are shared\nbetween the different model types.", "operationId": "v4.v4.statuses.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of tag.", "required": true, "schema": { "type": "string", "enum": [ "assignment", "list", "candidate", "lead", "person", "opportunity", "client", "task", "meeting", "revenue", "invoice", "note" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } } } } } } }, "/v4/assignments/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to an assignment.", "operationId": "v4.v4.assignments.candidates.store", "requestBody": { "description": "The body for adding candidates to assignments.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the assignment cannot be found." } } } }, "/v4/assignments/{assignmentId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "operationId": "v4.v4.assignments.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "operationId": "v4.v4.assignments.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The assignment ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The assignment, people, or tags specified do not exist." } } } }, "/v4/projects/{projectId}/candidates": { "get": { "tags": [ "Projects (Candidates)" ], "summary": "Fetches candidates from a specific project.", "operationId": "v4.v4.projects.candidates.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.v4.candidate.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v4.person.fieldsWithCandidate" }, { "$ref": "#/components/parameters/api.v4.person.exclude" }, { "$ref": "#/components/parameters/api.v4.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes a project candidate by ID.", "operationId": "v4.v4.projects.candidates.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "204": { "description": "successful operation." }, "404": { "description": "Person with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v4/people/notes": { "post": { "tags": [ "People (Notes)", "Notes" ], "summary": "Adds notes to one or more people.", "operationId": "v4.v4.", "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.note.storeRequest" }, { "properties": { "people": { "description": "An array of person IDs that will have the notes added.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } ] } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.notesUpdateResponse" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/notes/{noteId}": { "put": { "tags": [ "People (Notes)", "Notes" ], "summary": "Updates a note.", "operationId": "v4.v4..2", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Notes)", "Notes" ], "summary": "Deletes a note.", "operationId": "v4.v4..3", "parameters": [ { "name": "noteId", "in": "path", "description": "The note ID or the group code.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that note." } } } }, "/v4/companies/{companyId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.companies.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.companies.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.projects.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.projects.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/assignments/{searchFirmBriefId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.assignments.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.assignments.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/opportunities/{opportunityId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.opportunities.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.opportunities.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.people.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.people.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{searchFirmListId}/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieves all notes for an item.", "operationId": "v4.v4.lists.notes.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api.v3.note.user" }, { "$ref": "#/components/schemas/api.v3.note.system" }, { "$ref": "#/components/schemas/api.v3.note.compliance" }, { "$ref": "#/components/schemas/api.v3.note.feedback" } ] } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Notes" ], "summary": "Adds notes to an item.", "operationId": "v4.v4.lists.notes.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "project", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.companies.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.companies.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.projects.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.projects.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/assignments/{searchFirmBriefId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.assignments.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.assignments.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/opportunities/{opportunityId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.opportunities.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.opportunities.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.people.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.people.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{searchFirmListId}/notes/{noteId}": { "put": { "tags": [ "Notes" ], "summary": "Updates a note on an item.", "operationId": "v4.v4.lists.notes.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.note" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Deletes a note from an item.", "operationId": "v4.v4.lists.notes.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "noteId", "in": "path", "description": "The note ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.companies.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.projects.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/assignments/{searchFirmBriefId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.assignments.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/opportunities/{opportunityId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.opportunities.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.people.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{searchFirmListId}/documents": { "post": { "tags": [ "Documents" ], "summary": "Add documents and attachments.", "operationId": "v4.v4.lists.documents.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to add a document to.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.documentRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.document" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.companies.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/projects/{projectId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.projects.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/assignments/{searchFirmBriefId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.assignments.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/opportunities/{opportunityId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.opportunities.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/people/{personId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.people.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/lists/{searchFirmListId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieves all tasks for an item.", "operationId": "v4.v4.lists.tasks.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/companies/{companyId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.companies.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/projects/{projectId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.projects.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/assignments/{searchFirmBriefId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.assignments.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/opportunities/{opportunityId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.opportunities.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/people/{personId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.people.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/lists/{searchFirmListId}/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Retrieves all meetings for an item.", "operationId": "v4.v4.lists.meetings.index", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/companies/{companyId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.companies.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.companies.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.companies.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.projects.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.projects.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.projects.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/assignments/{searchFirmBriefId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.assignments.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.assignments.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.assignments.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/opportunities/{opportunityId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.opportunities.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.opportunities.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.opportunities.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.people.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.people.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.people.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{searchFirmListId}/additional-info": { "get": { "tags": [ "Custom Values" ], "summary": "Retrieves all custom values for an item.", "operationId": "v4.v4.lists.additional-info.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "put": { "tags": [ "Custom Values" ], "summary": "Adds or updates a custom value for an item.", "operationId": "v4.v4.lists.additional-info.update", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.customValue.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Custom Values" ], "summary": "Deletes a custom value from an item.", "operationId": "v4.v4.lists.additional-info.destroy", "parameters": [ { "name": "type", "in": "path", "description": "The type of item to update.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people", "opportunities" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The custom value IDs", "required": true, "content": { "application/json": { "schema": { "properties": { "customValues": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or custom value with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.companies.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.projects.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/assignments/{searchFirmBriefId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.assignments.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/opportunities/{opportunityId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.opportunities.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.people.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{searchFirmListId}/status/{statusId}": { "post": { "tags": [ "Status tags" ], "summary": "Adds or updates a status for an item.", "operationId": "v4.v4.lists.status.store", "parameters": [ { "name": "type", "in": "path", "description": "The type of model to update.", "required": true, "schema": { "type": "string", "enum": [ "projects", "assignments", "opportunities", "companies" ] } }, { "name": "id", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "statusId", "in": "path", "description": "The ID of the status to be updated", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Item or status with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/off-limits/agreements/companies/{companyId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "operationId": "v4.v4.companies.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/off-limits/agreements/people/{personId}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for a specific person or a company", "operationId": "v4.v4.people.offlimits-agreements.show", "parameters": [ { "name": "type", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "id", "in": "path", "description": "The company or person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/companies/{companyId}/links": { "post": { "tags": [ "Companies (Links)" ], "summary": "Adds a new link to a company.", "operationId": "v4.v4.companies.links.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/links": { "post": { "tags": [ "People (Links)" ], "summary": "Adds a new link to a person.", "operationId": "v4.v4.people.links.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/links/{linkId}": { "put": { "tags": [ "Companies (Links)" ], "summary": "Updates a link on a company.", "operationId": "v4.v4.companies.links.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.client.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that company." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Companies (Links)" ], "summary": "Deletes a link on a company.", "operationId": "v4.v4.companies.links.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v4/people/{personId}/links/{linkId}": { "put": { "tags": [ "People (Links)" ], "summary": "Updates a link on a person.", "operationId": "v4.v4.people.links.update", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be updated.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for creating links.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.linkRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.link" } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "People (Links)" ], "summary": "Deletes a link on a person.", "operationId": "v4.v4.people.links.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "linkId", "in": "path", "description": "The ID of the link to be deleted.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Link with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } } }, "/v4/custom-fields/{typeId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves all custom fields of a particular type", "operationId": "v4.v4.custom-fields.index", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/custom-fields/{typeId}/{customFieldId}": { "get": { "tags": [ "Custom Fields" ], "summary": "Retrieves a custom field by ID", "operationId": "v4.v4.custom-fields.show", "parameters": [ { "name": "typeId", "in": "path", "description": "The type of item query.", "required": true, "schema": { "type": "string", "enum": [ "companies", "projects", "people" ] } }, { "name": "customFieldId", "in": "path", "description": "The custom field ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.searchFirmCustomField" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/lists": { "get": { "tags": [ "Lists" ], "summary": "Fetches all lists.", "operationId": "v4.v4.lists.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.list.fields" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned lists will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.list" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Lists" ], "summary": "Creates a list", "operationId": "v4.v4.lists.store", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/lists/{search_firm_listId}": { "get": { "tags": [ "Lists" ], "summary": "Fetches a list by ID", "operationId": "v4.v4.lists.show", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "404": { "description": "List with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } } }, "put": { "tags": [ "Lists" ], "summary": "Updates a list", "operationId": "v4.v4.lists.update", "parameters": [ { "$ref": "#/components/parameters/api.list.fields" }, { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.list.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.list" } }, "type": "object" } } } }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "List with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that list." } } }, "delete": { "tags": [ "Lists" ], "summary": "Deletes a list by ID", "description": "Remove the specified resource from storage.", "operationId": "v4.v4.lists.destroy", "parameters": [ { "name": "search_firm_listId", "in": "path", "description": "The list ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "404": { "description": "List with that ID doesn't exist." } } } }, "/v4/lists/{projectId}/people": { "get": { "tags": [ "Lists", "People (Lists)" ], "summary": "Fetches all people in a list.", "operationId": "v4.v4.lists.people.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.v4.candidate.filterOn" }, { "$ref": "#/components/parameters/api.person.fields" }, { "$ref": "#/components/parameters/api.person.exclude" }, { "$ref": "#/components/parameters/api.person.counts" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.list.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.lead.status" }, { "$ref": "#/components/parameters/api.person.isCandidate" }, { "$ref": "#/components/parameters/api.person.onCompanies" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/lists/{projectId}/people/{personId}": { "put": { "tags": [ "Lists", "People (Lists)" ], "summary": "Add a person to a list.", "operationId": "v4.v4.lists.people.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.list" }, "meta": { "properties": { "person": { "$ref": "#/components/schemas/api.v4.person" }, "updated": { "$ref": "#/components/schemas/api.listPeopleUpdateResponse" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "delete": { "tags": [ "Lists", "People (Lists)" ], "summary": "Remove a person from a list.", "operationId": "v4.v4.lists.people.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the list.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.list" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/companies": { "get": { "tags": [ "Companies" ], "summary": "Fetches all companies.", "operationId": "v4.v4.companies.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.v4.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.v4.company.fields" }, { "$ref": "#/components/parameters/api.v4.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned companies will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Creates a company", "operationId": "v4.v4.companies.store", "requestBody": { "$ref": "#/components/requestBodies/api.v4.company.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.company" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "operationId": "v4.v4.companies.show", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } }, "put": { "tags": [ "Companies" ], "summary": "Updates a company", "operationId": "v4.v4.companies.update", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.company.updateRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.company" } }, "type": "object" } } } }, "422": { "description": "Company with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } }, "delete": { "tags": [ "Companies" ], "summary": "Deletes a company by ID", "operationId": "v4.v4.companies.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that company." } } } }, "/v4/clients/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Fetches a company by ID", "operationId": "v4.v4.client.show", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.company" } }, "type": "object" } } } }, "404": { "description": "Company with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that company." } } } }, "/v4/clients": { "get": { "tags": [ "Clients" ], "summary": "Fetches all clients.", "operationId": "v4.v4.clients.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.v4.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.v4.company.fields" }, { "$ref": "#/components/parameters/api.v4.company.exclude" }, { "$ref": "#/components/parameters/api.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.withArchived" }, { "$ref": "#/components/parameters/api.archived" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned clients will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/people/{personId}/positions": { "get": { "tags": [ "People (Positions)" ], "summary": "Gets all positions for a person", "operationId": "v4.v4.people.positions.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.position.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "startDate" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person.position" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "People (Positions)" ], "summary": "Creates a position for a person", "operationId": "v4.v4.people.positions.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/positions/{positionId}": { "put": { "tags": [ "People (Positions)" ], "summary": "Updates a position for a person", "operationId": "v4.v4.people.positions.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The ID of the position", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The position body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.position" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } }, "delete": { "tags": [ "People (Positions)" ], "summary": "Deletes a position for a person", "operationId": "v4.v4.people.positions.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "positionId", "in": "path", "description": "The position ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Position with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that position." } } } }, "/v4/people/{personId}/education": { "get": { "tags": [ "People (Education/Qualifications)" ], "summary": "Gets all educations for a person", "operationId": "v4.v4.people.education.index", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.person.education.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt", "start" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "People (Education/Qualifications)" ], "summary": "Creates a education for a person", "operationId": "v4.v4.people.education.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/education/{educationId}": { "put": { "tags": [ "People (Education/Qualifications)" ], "summary": "Updates an education for a person", "operationId": "v4.v4.people.education.update", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The ID of the education", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The Education body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.education" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Position with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that person." } } }, "delete": { "tags": [ "People (Education/Qualifications)" ], "summary": "Deletes an education for a person", "operationId": "v4.v4.people.education.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "educationId", "in": "path", "description": "The education ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Education with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that education." } } } }, "/v4/people/{personId}/confidential": { "post": { "tags": [ "People (Confidential Details)" ], "summary": "Sets confidential details for a person", "operationId": "v4.v4.people.confidential.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The confidential details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.confidential.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.confidential" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/aspirations": { "post": { "tags": [ "People (Aspirations)" ], "summary": "Sets aspiration details for a person", "operationId": "v4.v4.people.aspirations.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The aspiration details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.aspiration.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.aspiration" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/languages": { "post": { "tags": [ "People (Languages)" ], "summary": "Add a language for a person", "description": "Adds a new language or updates an existing language for a candidate.", "operationId": "v4.v4.people.languages.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The language details body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.language.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.person.language" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/languages/{languageId}": { "delete": { "tags": [ "People (Languages)" ], "summary": "Delete a language for a person", "description": "Deletes a language for a candidate.", "operationId": "v4.v4.people.languages.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "languageId", "in": "path", "description": "The ID of the language", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Language with that ID doesn't exist." } } } }, "/v4/people/{personId}/current-status": { "post": { "tags": [ "People (Current Status)" ], "summary": "Sets current status for a person", "operationId": "v4.v4.people.current-status.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The current status body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.currentStatus.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v2.person.currentStatus" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/profile-picture": { "post": { "tags": [ "People (Profile)" ], "summary": "Update a person's profile picture", "description": "Update candidate profile picture", "operationId": "v4.v4.people.profile-picture.store", "parameters": [ { "name": "personId", "in": "path", "description": "The ID of the person", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/api.candidate.profilePicture.storeRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } }, "403": { "description": "The authenticated user does not have permission to update that person." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/languages/codes": { "get": { "tags": [ "People (Languages)" ], "summary": "Get all language codes and names", "description": "Returns a list of all language codes and their corresponding names.", "operationId": "v4.v4.languages.codes", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.language.codes" } } }, "type": "object" } } } } } } }, "/v4/notes": { "get": { "tags": [ "Notes" ], "summary": "Fetches all notes", "operationId": "v4.v4.notes.forFirm", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "name": "type", "in": "query", "description": "Filter the results by the type of parent model.", "schema": { "type": "string", "enum": [ "companies", "projects", "people", "lists" ] } }, { "name": "id", "in": "query", "description": "The ID of the parent model", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.firm.noteType" }, { "$ref": "#/components/parameters/api.note.filterOn" }, { "$ref": "#/components/parameters/api.note.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.note.tags" }, { "$ref": "#/components/parameters/api.note.contacts" }, { "$ref": "#/components/parameters/api.note.companies" }, { "$ref": "#/components/parameters/api.note.projects" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "name": "withPinned", "in": "query", "description": "By setting this parameter pinned notes will be returned first in the response.", "allowEmptyValue": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/revenues": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches all revenues.", "operationId": "v4.v4..4", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.revenue.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/invoices": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all invoices.", "operationId": "v4.v4..5", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.invoice.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.invoice.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.invoice.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees.", "operationId": "v4.v4..6", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/percent-splits": { "get": { "tags": [ "Billing (Percent Splits)" ], "summary": "Fetches all percent splits.", "operationId": "v4.v4..7", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.feeSplits.filterOn" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.feeSplits.sortBy" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } } }, "/v4/fixed-fees/{fixedFeeId}": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches a fixed fee by ID.", "description": "Display the specified resource.", "operationId": "v4.v4.fixed-fees.show", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "delete": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Deletes fixed fee item.", "operationId": "v4.v4.fixed-fees.destroy", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Fixed fee with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/fixed-fees/{fixedFeeId}/lock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Locks a fixed fee.", "description": "Lock fixed fee", "operationId": "v4.v4.fixed-fees.lock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/fixed-fees/{fixedFeeId}/unlock": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Unlocks a fixed fee.", "description": "Update the specified resource in storage.", "operationId": "v4.v4.fixed-fees.unlock", "parameters": [ { "name": "fixedFeeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/revenues/{revenueId}": { "get": { "tags": [ "Billing (Revenues)" ], "summary": "Fetches a revenue by ID.", "description": "Display the specified resource.", "operationId": "v4.v4.revenues.show", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.v4.revenue.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "delete": { "tags": [ "Billing (Revenues)" ], "summary": "Deletes revenue item.", "operationId": "v4.v4.revenues.destroy", "parameters": [ { "name": "revenueId", "in": "path", "description": "The revenue ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item or note with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/revenues/{revenueId}/lock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Locks a revenue.", "description": "Lock revenue", "operationId": "v4.v4.revenues.lock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "type": "object" } } } } } } }, "/v4/revenues/{revenueId}/unlock": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Unlocks a revenue.", "description": "Unlock revenue", "operationId": "v4.v4.revenues.unlock", "parameters": [ { "name": "revenueId", "in": "path", "description": "The ID of the revenue.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "type": "object" } } } } } } }, "/v4/invoices/{invoiceId}": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches a invoice by ID.", "description": "Display the specified resource.", "operationId": "v4.v4.invoices.show", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The invoice ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.v4.invoice.fields" } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that invoice." } } }, "delete": { "tags": [ "Billing (Invoices)" ], "summary": "Deletes an invoice by ID.", "operationId": "v4.v4.invoices.destroy", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Invoice with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/invoices/{invoiceId}/lock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Locks an invoice.", "operationId": "v4.v4.invoices.lock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.lockInvoice" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "type": "object" } } } } } } }, "/v4/invoices/{invoiceId}/unlock": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Unlocks an invoice.", "operationId": "v4.v4.invoices.unlock", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "type": "object" } } } } } } }, "/v4/projects/{projectId}/billing": { "get": { "tags": [ "Billing" ], "summary": "Fetches billing information for an item.", "operationId": "v4.v4.projects.billing", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/projects/{projectId}/revenues": { "post": { "tags": [ "Billing (Revenues)" ], "summary": "Creates a revenue.", "operationId": "v4.v4.projects.revenues.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/revenues/{revenueId}": { "put": { "tags": [ "Billing (Revenues)" ], "summary": "Updates a revenue", "operationId": "v4.v4.projects.revenues.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The ID of the project", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "revenueId", "in": "path", "description": "The ID of the revenue", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.revenueStore" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/invoices": { "post": { "tags": [ "Billing (Invoices)" ], "summary": "Adds invoice to billing.", "operationId": "v4.v4.projects.invoices.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/invoices/{invoiceId}": { "put": { "tags": [ "Billing (Invoices)" ], "summary": "Updates an invoice.", "description": "Update the specified resource in storage.", "operationId": "v4.v4.projects.invoices.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The item ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "invoiceId", "in": "path", "description": "The ID of the invoice.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.invoice.storeRequest" } } } }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/fixed-fees": { "get": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Fetches all fixed fees by project ID.", "description": "Display a listing of the resource.", "operationId": "v4.v4.projects.fixed-fees.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } }, "type": "object" } } } }, "404": { "description": "Revenue with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that revenue." } } }, "post": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Adds new fixed fee to billing.", "operationId": "v4.v4.projects.fixed-fees.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/fixed-fees/{fixed_feeId}": { "put": { "tags": [ "Billing (Fixed Fees)" ], "summary": "Updates a fixed fee.", "operationId": "v4.v4.projects.fixed-fees.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "fixed_feeId", "in": "path", "description": "The fixed fee ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.fixedFee.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/billing/contact": { "get": { "tags": [ "Billing" ], "summary": "Fetches the project billing contact", "operationId": "v4.v4.projects.billing.contact.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.person.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project or that project's billing information." } } }, "post": { "tags": [ "Billing" ], "summary": "Adds the contact to a project billing.", "operationId": "v4.v4.projects.billing.contact.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The billing contact body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.billing.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.person.full" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/billing/contact/{contactId}": { "delete": { "tags": [ "Billing" ], "summary": "Removes the contact from project billing.", "operationId": "v4.v4.projects.billing.contact", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The person ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/invoice-templates": { "get": { "tags": [ "Billing (Invoices)" ], "summary": "Fetches all the invoice templates.", "description": "Display a listing of the resource.", "operationId": "v4.v4.invoice-templates.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.revenue.sortBy" }, { "$ref": "#/components/parameters/api.sortOrder" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoiceTemplate" } } }, "type": "object" } } } } } } }, "/v4/off-limits/agreements/{modelType}": { "get": { "tags": [ "Off-Limits" ], "summary": "Retrieves all off-limits agreements for people or companies", "operationId": "v4.v4.offlimits-agreements.index", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "parameter": "api.offLimits.agreement.sortBy", "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "createdAt", "updatedAt" ], "example": "createdAt" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." } } }, "post": { "tags": [ "Off-Limits" ], "summary": "Creates an off-limits agreement for a person or a company", "operationId": "v4.v4.offlimits-agreements.store", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } } ], "requestBody": { "description": "The body for creating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/off-limits/agreements/{modelType}/{agreementId}": { "put": { "tags": [ "Off-Limits" ], "summary": "Updates an off-limits agreement for a person or a company", "operationId": "v4.v4.offlimits-agreements.update", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating an off-limits agreement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.offlimits.agreement.storeRequest" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Item with that ID doesn't exist." } } }, "delete": { "tags": [ "Off-Limits" ], "summary": "Deletes an off-limits agreement for a person or a company", "operationId": "v4.v4.offlimits-agreements.destroy", "parameters": [ { "name": "modelType", "in": "path", "description": "The model type", "required": true, "schema": { "type": "string", "enum": [ "companies", "people" ] } }, { "name": "agreementId", "in": "path", "description": "The off-limits agreement id", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have permission to see that item." }, "404": { "description": "Item with that ID doesn't exist." } } } }, "/v4/opportunities/{opportunityId}/completion": { "post": { "tags": [ "Projects" ], "summary": "Adds a completion percentage to an opportunity", "operationId": "v4.v4.opportunities.completion.store", "parameters": [ { "name": "opportunityId", "in": "path", "description": "The opportunity ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding a completion percentage to an opportunity", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.opportunities.completion.storeRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.project.default" } }, "type": "object" } } } }, "404": { "description": "Opportunity with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that opportunity." } } } }, "/v4/people/{personId}/import-email": { "post": { "tags": [ "People (Import Emails)" ], "summary": "Imports people email.", "operationId": "v4.v4..8", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.importEmailRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.importEmailResource" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/tasks/{id}/done": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's completion status.", "operationId": "v4.v4.tasks.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v4.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.taskRequestUpdateDone" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/tasks/{id}/priority": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's priority.", "operationId": "v4.v4.tasks.updateType.2", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.taskRequestUpdatePriority" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/tasks/{id}/pinned": { "put": { "tags": [ "Tasks" ], "summary": "Updates a task's pinned status.", "operationId": "v4.v4.tasks.updateType.3", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.taskRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Fetches all tasks.", "operationId": "v4.v4.tasks.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.done", "name": "done", "in": "query", "description": "Return only completed or active results", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue tasks", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private tasks", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned tasks", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter tasks by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } }, { "parameter": "api.v4.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Creates a task.", "operationId": "v4.v4.tasks.store", "parameters": [ { "parameter": "api.v4.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.taskRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task" } } } }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Fetches a task by ID.", "operationId": "v4.v4.tasks.show", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v4.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task" } } }, "type": "object" } } } }, "404": { "description": "Task with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." } } }, "put": { "tags": [ "Tasks" ], "summary": "Updates a task.", "operationId": "v4.v4.tasks.update", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.v4.task.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.taskRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.task" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that task and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Deletes a task.", "operationId": "v4.v4.tasks.destroy", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Task with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/meetings/{meetingId}/{typeId}": { "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting's pinned status.", "operationId": "v4.v4.meetings.updateType", "parameters": [ { "name": "id", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.meetingRequestUpdatePinned" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/meetings": { "get": { "tags": [ "Meetings" ], "summary": "Fetches all meetings.", "operationId": "v4.v4.meetings.index", "parameters": [ { "parameter": "api.page", "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, { "parameter": "api.order", "name": "order", "in": "query", "description": "Sort order to show results", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "parameter": "api.sort", "name": "sort", "in": "query", "description": "Sort field to order results", "schema": { "type": "string", "enum": [ "start_date_utc", "created_at", "updated_at", "title" ] } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } }, { "parameter": "api.past", "name": "past", "in": "query", "description": "Return only past or upcoming meetings", "schema": { "type": "boolean" } }, { "parameter": "api.overdue", "name": "overdue", "in": "query", "description": "Return only overdue or non-overdue meetings", "schema": { "type": "boolean" } }, { "parameter": "api.private", "name": "private", "in": "query", "description": "Return only private or non-private meetings", "schema": { "type": "boolean" } }, { "parameter": "api.pinned", "name": "pinned", "in": "query", "description": "Return only private or non-pinned meetings", "schema": { "type": "boolean" } }, { "parameter": "api.priority", "name": "priority[]", "in": "query", "description": "Filter meetings by specific priorities", "schema": { "type": "array", "items": { "type": "string", "enum": [ 1, 2, 3, 4 ] }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Meetings" ], "summary": "Creates a meeting.", "operationId": "v4.v4.meetings.store", "parameters": [ { "parameter": "api.v4.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.meetingRequestStore" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting" } } } }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/meetings/{meetingId}": { "get": { "tags": [ "Meetings" ], "summary": "Fetches a meeting by ID.", "operationId": "v4.v4.meetings.show", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting" } } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." } } }, "put": { "tags": [ "Meetings" ], "summary": "Updates a meeting.", "operationId": "v4.v4.meetings.update", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "parameter": "api.meeting.fields", "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.field" }, "default": [] } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.meetingRequestUpdate" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.meeting" } }, "type": "object" } } } }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that meeting and they must have the correct 'edit' permissions for any associated context." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Meetings" ], "summary": "Deletes a meeting.", "operationId": "v4.v4.meetings.destroy", "parameters": [ { "name": "meetingId", "in": "path", "description": "The meeting ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Meeting with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." }, "422": { "description": "Data was invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/graph/connected": { "get": { "tags": [ "Meetings" ], "summary": "Fetches Microsoft Graph details on connected accounts.", "operationId": "v4.v4.graph.connected", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.graph" } } }, "type": "object" } } } } } } }, "/v4/relationships": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationships for a particular type.", "description": "Display a listing of the resource.", "operationId": "v4.v4.relationships.index", "parameters": [ { "name": "id", "in": "query", "description": "The id of the model type to get relationships for.", "schema": { "type": "integer" }, "example": "123" }, { "name": "type", "in": "query", "description": "The model type to get relationships for.", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "person" }, { "name": "relatedType", "in": "query", "description": "The relationship type to be returned. Exclude to return all relationship types", "schema": { "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ] }, "example": "company" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Relationships" ], "summary": "Creates a new relationship", "description": "Store a newly created resource in storage.", "operationId": "v4.v4.relationships.store", "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v4/relationships/{relationshipId}": { "put": { "tags": [ "Relationships" ], "summary": "Updates a relationship", "description": "Update the specified resource in storage.", "operationId": "v4.v4.relationships.update", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.updateRequest" }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.relationships.single" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } }, "delete": { "tags": [ "Relationships" ], "summary": "Deletes a relationship", "description": "Remove the specified resource from storage.", "operationId": "v4.v4.relationships.destroy", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The relationship ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.relationships.storeDeleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v4/relationship-labels": { "get": { "tags": [ "Relationships" ], "summary": "Fetches relationship labels.", "description": "Display a listing of the resource.", "operationId": "v4.v4.relationship-labels.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationshipLabel" } } }, "type": "object" } } } } } } }, "/v4/companies/{companyId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.companies.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/projects/{projectId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.projects.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/assignments/{searchFirmBriefId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.assignments.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/opportunities/{opportunityId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.opportunities.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/people/{personId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.people.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/lists/{searchFirmListId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Download documents and attachments.", "operationId": "v4.v4.lists.documents.show", "parameters": [ { "name": "type", "in": "path", "description": "The type of model belonging to the document.", "required": true, "schema": { "type": "string", "enum": [ "companies", "assignments", "opportunities", "people", "lists" ] } }, { "name": "id", "in": "path", "description": "The item ID of the model.", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "documentId", "in": "path", "description": "The document ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Item with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to see that item." } } } }, "/v4/projects/candidates": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds a person as a candidate to a project.", "operationId": "v4.v4.projects.candidates.store", "requestBody": { "description": "The body for adding candidates to projects.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.person.candidatesUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.project.default.api.person.candidatesUpdateResponse" } } } }, "404": { "description": "The people or the project cannot be found." } } } }, "/v4/projects/{projectId}/convert": { "put": { "tags": [ "Projects" ], "summary": "Convert a project from one type to another", "operationId": "v4.v4.project.convert", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "convert", "in": "query", "description": "Converted Type", "required": true, "schema": { "type": "string", "minimum": 1, "enum": [ "assignment", "opportunity", "list" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.project.default" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } }, "422": { "description": "Project with that ID doesn't exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to see that project." } } } }, "/v4/projects/{projectId}/candidates/statuses/{tagId}": { "post": { "tags": [ "Projects (Candidates)" ], "summary": "Adds pipeline tags to candidates.", "operationId": "v4.v4.projects.candidates.statuses.update", "parameters": [ { "name": "id", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for adding pipeline tags to candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The project, people, or tags specified do not exist." } } }, "delete": { "tags": [ "Projects (Candidates)" ], "summary": "Removes pipeline tags from candidates.", "operationId": "v4.v4.projects.candidates.statuses.destroy", "parameters": [ { "name": "id", "in": "path", "description": "The project ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "The body for removing pipeline tags from candidates.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.pipelineUpdateResponse" } } } }, "404": { "description": "The project, people, or tags specified do not exist." } } } }, "/v4/projects/{projectId}/completion": { "put": { "tags": [ "Projects" ], "summary": "Updates the completion percentage on a project", "operationId": "v4.v4.project.completion", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for updating a completion percentage to an project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.completion.updateRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.default" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } } }, "/v4/projects/{projectId}/actions": { "get": { "tags": [ "Projects" ], "summary": "Fetches all Actions from a particular Project.", "operationId": "v4.v4.projects.actions.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.actions" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } }, "put": { "tags": [ "Projects" ], "summary": "Update Actions", "operationId": "v4.v4.projects.actions.update", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding Actions to a project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.project.action.update" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.project.actions" } }, "type": "object" } } } }, "404": { "description": "Project with that ID does not exist." }, "403": { "description": "The authenticated user does not have permission to update that project." } } } }, "/v4/companies/{companyId}/consultants": { "get": { "tags": [ "Companies" ], "summary": "Fetches all consultants belonging to a company.", "operationId": "v4.v4.companies.consultants.index", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds a consultant to a company.", "operationId": "v4.v4.companies.consultants.store", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" }, { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.consultant.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.search.user" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/consultants": { "get": { "tags": [ "Projects" ], "summary": "Fetches all consultants belonging to a project.", "operationId": "v4.v4.projects.consultants.index", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds a consultant to a project.", "operationId": "v4.v4.projects.consultants.store", "parameters": [ { "$ref": "#/components/parameters/api.v3.search.user.fields" }, { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.consultant.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.search.user" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/consultants/{consultantId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes a consultant from a company", "operationId": "v4.v4.companies.consultants.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "consultantId", "in": "path", "description": "The consultant ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/projects/{projectId}/consultants/{consultantId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes a consultant from a project", "operationId": "v4.v4.projects.consultants.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "consultantId", "in": "path", "description": "The consultant ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/companies/{companyId}/office-groups": { "get": { "tags": [ "Companies" ], "summary": "Fetches all office groups belonging to a company.", "operationId": "v4.v4.companies.office-groups.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds an office group to a company.", "operationId": "v4.v4.companies.office-groups.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.officeGroup.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.officeGroup" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/office-groups": { "get": { "tags": [ "Projects" ], "summary": "Fetches all office groups belonging to a project.", "operationId": "v4.v4.projects.office-groups.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds an office group to a project.", "operationId": "v4.v4.projects.office-groups.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.officeGroup.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.officeGroup" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/office-groups/{officeGroupId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes an office group from a company", "operationId": "v4.v4.companies.office-groups.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "officeGroupId", "in": "path", "description": "The office group ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/projects/{projectId}/office-groups/{officeGroupId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes an office group from a project", "operationId": "v4.v4.projects.office-groups.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "officeGroupId", "in": "path", "description": "The office group ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/companies/{companyId}/regions": { "get": { "tags": [ "Companies" ], "summary": "Fetches all regions belonging to a company.", "operationId": "v4.v4.companies.regions.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Adds a region to a company.", "operationId": "v4.v4.companies.regions.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.region.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.region" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/regions": { "get": { "tags": [ "Projects" ], "summary": "Fetches all regions belonging to a project.", "operationId": "v4.v4.projects.regions.index", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Adds a region to a project.", "operationId": "v4.v4.projects.regions.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v3.region.storeRequest" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v3.region" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/regions/{regionId}": { "delete": { "tags": [ "Companies" ], "summary": "Removes a region from a company", "operationId": "v4.v4.companies.regions.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "regionId", "in": "path", "description": "The region ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/projects/{projectId}/regions/{regionId}": { "delete": { "tags": [ "Projects" ], "summary": "Removes a region from a project", "operationId": "v4.v4.projects.regions.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "regionId", "in": "path", "description": "The region ID.", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Consultant with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/projects/{projectId}/contacts": { "get": { "tags": [ "Projects (Contacts)" ], "summary": "Fetches contacts from a specific project.", "operationId": "v4.v4.model.contacts.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.ids" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.tags" }, { "$ref": "#/components/parameters/api.v4.person.filterOn" }, { "$ref": "#/components/parameters/api.person.sortBy" }, { "$ref": "#/components/parameters/api.person.onCompanies" }, { "$ref": "#/components/parameters/api.v3.person.fields" }, { "$ref": "#/components/parameters/api.v3.person.exclude" }, { "$ref": "#/components/parameters/api.v3.person.counts" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/api.pageMeta" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Projects (Contacts)" ], "summary": "Adds a person as a contact to a project.", "operationId": "v4.v4.model.contacts.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "description": "The body for adding contacts to projects.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.projectContactStoreRequest" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.person" } } } }, "404": { "description": "The people or the project cannot be found." } } } }, "/v4/projects/{projectId}/contacts/{contactId}": { "delete": { "tags": [ "Projects (Contacts)" ], "summary": "Removes a person as a contact from a project.", "operationId": "v4.v4.model.contacts.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "contactId", "in": "path", "description": "The contact ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Person or project with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to delete that person." } } } }, "/v4/projects-increment": { "get": { "tags": [ "Projects" ], "summary": "Fetches the next available project IDs if you have automatic numbering enabled.", "operationId": "v4.v4..9", "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.automaticNumber" } } }, "type": "object" } } } }, "403": { "description": "The authenticated user does not have automatic project ID numbering enabled." } } } }, "/v4/projects/{projectId}/target-companies": { "get": { "tags": [ "Target Companies" ], "summary": "Lists the target companies attached to a project.", "description": "Returns a paginated list of companies for the project's target companies view. Results are paginated: use the `page` and `count` (default 100) query parameters to navigate the pages, and read the pagination state from the `links` and `meta` response properties.", "operationId": "v4.v4.projects.target-companies.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.v4.company.filterOn" }, { "$ref": "#/components/parameters/api.company.sortBy" }, { "$ref": "#/components/parameters/api.v4.company.fields" }, { "$ref": "#/components/parameters/api.v4.company.exclude" }, { "$ref": "#/components/parameters/api.v4.company.counts" }, { "$ref": "#/components/parameters/api.sortOrder" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.from" }, { "$ref": "#/components/parameters/api.to" }, { "$ref": "#/components/parameters/api.since" }, { "$ref": "#/components/parameters/api.before" }, { "$ref": "#/components/parameters/api.between" }, { "$ref": "#/components/parameters/api.view" }, { "$ref": "#/components/parameters/api.fuzzy" }, { "$ref": "#/components/parameters/api.tags" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.links" } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/api.pageMeta" }, { "properties": { "addedCompanyList": { "description": "IDs of every company already attached to the project as a target company (not paginated).", "type": "array", "items": { "type": "integer" } }, "unfilteredTotal": { "description": "The total number of target companies attached to the project, ignoring the query and filters.", "type": "integer", "example": 12 } }, "type": "object" } ] } }, "type": "object" } } } }, "403": { "description": "Not permitted to see that project." }, "404": { "description": "Project with that ID does not exist." } } }, "post": { "tags": [ "Target Companies" ], "summary": "Adds one or more companies to a project as target companies.", "operationId": "v4.v4.projects.target-companies.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "description": "Company IDs (client_id) to add as target companies.", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "added": { "type": "array", "items": { "type": "object" } }, "notAdded": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "403": { "description": "Not permitted to edit that project." }, "404": { "description": "Project with that ID does not exist." }, "422": { "description": "Validation error (unknown or missing company IDs)." } } } }, "/v4/companies/{companyId}/primary-owner": { "put": { "tags": [ "Owners" ], "summary": "Add primary owner to a company Or updates the ownership to an existing owner.", "operationId": "v4.v4.companies.owners.primary", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.primary-owner.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/projects/{projectId}/primary-owner": { "put": { "tags": [ "Owners" ], "summary": "Add primary owner to a project Or updates the ownership to an existing owner.", "operationId": "v4.v4.projects.owners.primary", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.primary-owner.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/people/{personId}/primary-owner": { "put": { "tags": [ "Owners" ], "summary": "Add primary owner to a person Or updates the ownership to an existing owner.", "operationId": "v4.v4.people.owners.primary", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.primary-owner.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } } }, "/v4/companies/{companyId}/owners": { "get": { "tags": [ "Owners" ], "summary": "Fetches all owner-entities (office groups, regions and users) belonging to a company.", "operationId": "v4.v4.companies.owners.index", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "ownerType", "in": "query", "description": "The owner type", "required": false, "schema": { "type": "string", "minimum": 1, "enum": [ "users", "officeGroups", "regions" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.owner" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Owners" ], "summary": "Adds an owner to a company Or updates the ownership tag of an existing owner.", "operationId": "v4.v4.companies.owners.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.owners.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Removes an owner (office-groups, regions and users) from a company", "operationId": "v4.v4.companies.owners.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The company ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.owners.deleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Owner with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/projects/{projectId}/owners": { "get": { "tags": [ "Owners" ], "summary": "Fetches all owner-entities (office groups, regions and users) belonging to a project.", "operationId": "v4.v4.projects.owners.index", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "ownerType", "in": "query", "description": "The owner type", "required": false, "schema": { "type": "string", "minimum": 1, "enum": [ "users", "officeGroups", "regions" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.owner" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Owners" ], "summary": "Adds an owner to a project Or updates the ownership tag of an existing owner.", "operationId": "v4.v4.projects.owners.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.owners.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Removes an owner (office-groups, regions and users) from a project", "operationId": "v4.v4.projects.owners.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.owners.deleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Owner with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/people/{personId}/owners": { "get": { "tags": [ "Owners" ], "summary": "Fetches all owner-entities belonging to a person.", "operationId": "v4.v4.people.owners.index", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "ownerType", "in": "query", "description": "The owner type", "required": false, "schema": { "type": "string", "minimum": 1, "enum": [ "users", "officeGroups", "regions" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.owner" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Owners" ], "summary": "Adds an owner to a person Or updates the ownership tag of an existing owner.", "operationId": "v4.v4.people.owners.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.people.owners.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/api.v4.owner" } }, "type": "object" } } } }, "422": { "description": "Data was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.422" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Removes an owner (office-groups, regions and users) from a person", "operationId": "v4.v4.people.owners.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.owners.deleteRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Owner with that ID doesn't exist." }, "403": { "description": "The authenticated user does not have permission to perform that action." } } } }, "/v4/companies/{companyId}/owners/tags": { "post": { "tags": [ "Owners" ], "summary": "Stores tags for an owner in a company.", "operationId": "v4.v4.companies.owners.tags.store", "parameters": [ { "name": "companyId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Deletes tags for an owner in a company.", "operationId": "v4.v4.companies.owners.tags.destroy", "parameters": [ { "name": "companyId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } } }, "/v4/projects/{projectId}/owners/tags": { "post": { "tags": [ "Owners" ], "summary": "Stores tags for an owner in a project.", "operationId": "v4.v4.projects.owners.tags.store", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Deletes tags for an owner in a project.", "operationId": "v4.v4.projects.owners.tags.destroy", "parameters": [ { "name": "projectId", "in": "path", "description": "The project ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } } }, "/v4/people/{personId}/owners/tags": { "post": { "tags": [ "Owners" ], "summary": "Stores tags for an owner in a person.", "operationId": "v4.v4.people.owners.tags.store", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } }, "delete": { "tags": [ "Owners" ], "summary": "Deletes tags for an owner in a person.", "operationId": "v4.v4.people.owners.tags.destroy", "parameters": [ { "name": "personId", "in": "path", "description": "The person ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "$ref": "#/components/requestBodies/api.v4.ownerTag.request" }, "responses": { "200": { "description": "successful operation.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } } } } }, "/v4/kpi-dashboards": { "get": { "tags": [ "KPI Dashboards" ], "summary": "Retrieves all personal KPI Dashboards", "description": "Get all personal Kpi Dashboards", "operationId": "v4.v4.kpi-dashboards.index", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.kpiDashboard.withCalculatedData" }, { "$ref": "#/components/parameters/api.kpiDashboard.refresh" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.kpiDashboard" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Forbidden - User lacks permission to view KPI dashboards", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." } }, "type": "object" } } } } } } }, "/v4/kpi-dashboards/global": { "get": { "tags": [ "KPI Dashboards" ], "summary": "Retrieves all firm global KPI Dashboards", "description": "Get all firm global Kpi Dashboards", "operationId": "v4.v4.kpi-dashboards.global", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.kpiDashboard.withCalculatedData" }, { "$ref": "#/components/parameters/api.kpiDashboard.refresh" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.kpiDashboard" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Forbidden - User lacks permission to view KPI dashboards", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." } }, "type": "object" } } } } } } }, "/v4/kpi-dashboards/shared": { "get": { "tags": [ "KPI Dashboards" ], "summary": "Retrieves all KPI Dashboards shared with the user", "description": "Get all shared kpi dashboards", "operationId": "v4.v4.kpi-dashboards.shared", "parameters": [ { "$ref": "#/components/parameters/api.query" }, { "$ref": "#/components/parameters/api.page" }, { "$ref": "#/components/parameters/api.count" }, { "$ref": "#/components/parameters/api.kpiDashboard.withCalculatedData" }, { "$ref": "#/components/parameters/api.kpiDashboard.refresh" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.kpiDashboard" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Forbidden - User lacks permission to view KPI dashboards", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." } }, "type": "object" } } } } } } }, "/v4/kpi-dashboards/{kpi_dashboardId}": { "get": { "tags": [ "KPI Dashboards" ], "summary": "Retrieves a single KPI Dashboard", "operationId": "v4.v4.kpi-dashboards.show", "parameters": [ { "name": "kpi_dashboardId", "in": "path", "description": "ID of the KPI Dashboard to retrieve", "required": true, "schema": { "type": "integer", "example": 1 } }, { "$ref": "#/components/parameters/api.kpiDashboard.withCalculatedData" }, { "$ref": "#/components/parameters/api.kpiDashboard.refresh" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "description": "KPI Dashboard resource data", "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Forbidden - User lacks permission to view this dashboard", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." } }, "type": "object" } } } }, "404": { "description": "KPI Dashboard not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No query results for model [App\\\\KpiDashboard]." } }, "type": "object" } } } } } } }, "/v4/me": { "get": { "tags": [ "Authentication" ], "summary": "Get authenticated user information", "description": "Returns basic information about the currently authenticated user", "operationId": "v4.v4..10", "responses": { "200": { "description": "Successful response with user information", "content": { "application/json": { "schema": { "required": [ "id", "email", "fullName" ], "properties": { "id": { "description": "The unique identifier of the user", "type": "integer", "example": 123 }, "email": { "description": "The email address of the user", "type": "string", "format": "email", "example": "user@example.com" }, "fullName": { "description": "The full name of the user", "type": "string", "example": "John Doe" } }, "type": "object" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } } } }, "/categories": { "get": { "tags": [ "Categories" ], "summary": "Fetches all categories and their values.", "operationId": "categories.index", "parameters": [ { "name": "lang", "in": "query", "description": "The language that the categories should be translated to.", "schema": { "type": "string", "enum": [ "en", "de", "fr", "es" ] } }, { "name": "include[]", "in": "query", "description": "The categories to be included in the request. To show all categories, do not include this parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "areas", "careers", "cities", "classifications", "countries", "companyTypes", "industries", "languages", "nalIndustries", "nalCareers", "teamSizes" ] }, "default": [] } }, { "name": "exclude[]", "in": "query", "description": "The categories to be excluded from the request", "schema": { "type": "array", "items": { "type": "string", "enum": [ "areas", "careers", "cities", "classifications", "countries", "companyTypes", "industries", "languages", "nalIndustries", "nalCareers", "teamSizes" ] }, "default": [] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.category" } } }, "type": "object" } } } } } } } }, "components": { "schemas": { "api.list.stats.tag": { "title": "Bucket Stats Tags", "properties": { "id": { "description": "Bucket", "type": "integer", "example": 1234 }, "count": { "type": "integer", "example": 3 }, "color": { "type": "string", "example": "#12ab12" }, "text": { "type": "string", "example": "LinkedIn" }, "order": { "type": "integer", "example": 3 } }, "type": "object" }, "api.career": { "title": "Career", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LocalizationTrait" }, { "properties": { "name": { "description": "Class Career", "type": "string", "example": "Architect (Building & Design)" }, "value": { "type": "string", "example": "Architect (Building & Design)" }, "parent_id": { "type": "integer", "example": "1234" } }, "type": "object" } ] }, "api.client.link.type": { "title": "Company Link Types", "description": "Class ClientLink", "type": "string", "enum": [ "general", "linkedin", "website", "xing" ] }, "api.companyType": { "title": "Company Type", "description": "Class CompanyType", "allOf": [ { "$ref": "#/components/schemas/LocalizationTrait" } ] }, "api.person.link.type": { "title": "Person Link Types", "description": "Class ContactLink", "type": "string", "enum": [ "linkedin", "website", "xing" ] }, "api.company.store": { "title": "Company Store Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info', 'address', or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "assignmentId": { "type": "integer", "example": "1234", "nullable": true }, "assignmentName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "address": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.company.update": { "title": "Company Update Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info', 'address', or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "assignmentId": { "type": "integer", "example": "1234", "nullable": true }, "assignmentName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "address": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } }, "type": "object" }, "api.category": { "title": "Category", "properties": { "id": { "type": "integer", "example": 1234 }, "parent_id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Chief Technology Officer" }, "matches": { "type": "string", "example": "CTO" }, "value": { "type": "integer", "example": 1234 } }, "type": "object" }, "api.aspiration.storeRequest": { "title": "Person Aspirations Request Body", "properties": { "careers": { "description": "An array of career IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "companyTypes": { "description": "An array of company type IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "industries": { "description": "An array of industry IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "locations": { "description": "An array of location IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "summary": { "description": "The summary of the person's aspirations.", "type": "string", "example": "I am looking for a new role in a fast paced environment." }, "permanentPosition": { "description": "The permanent position details if applicable", "properties": { "base": { "$ref": "#/components/schemas/api.currencyAmount" }, "bonus": { "description": "The bonus percentage amount", "type": "integer", "example": "60" }, "equity": { "description": "Whether the role includes equity", "type": "boolean", "example": false } }, "type": "object" }, "interimPosition": { "description": "The interim position details if applicable", "properties": { "rate": { "$ref": "#/components/schemas/api.currencyAmount" } }, "type": "object" }, "nedPosition": { "description": "The NED position details if applicable", "properties": { "rate": { "$ref": "#/components/schemas/api.currencyAmount" }, "classifications": { "description": "The classifications of the NED role", "type": "array", "items": { "type": "integer", "example": 1234 } }, "probono": { "description": "Whether the role is pro bono", "type": "boolean", "example": true }, "equity": { "description": "Whether the role includes equity", "type": "boolean", "example": false } }, "type": "object" } }, "type": "object" }, "api.confidential.storeRequest": { "title": "Person Confidential Request Body", "properties": { "baseSalary": { "$ref": "#/components/schemas/api.currencyAmount" }, "interimRate": { "$ref": "#/components/schemas/api.currencyAmount" }, "nedRate": { "$ref": "#/components/schemas/api.currencyAmount" }, "notice": { "description": "The number of months or hours that a user needs to give as notice leaving their current job. If the number is over 24 then it refers to hours otherwise it refers to months.", "type": "integer", "enum": [ 0, 336, 1, 2, 3, 6, 12, 24 ], "example": "3" }, "bonus": { "description": "The bonus percentage the person receives", "type": "integer", "example": 125 }, "probono": { "description": "True if the person is working pro bono, false otherwise", "type": "boolean", "example": true }, "additionalInfo": { "description": "Additional information", "type": "string", "example": "Open to giving more information" } }, "type": "object" }, "api.language.codes": { "title": "Language Codes", "properties": { "code": { "type": "string", "example": "en" }, "name": { "type": "string", "example": "English" } }, "type": "object" }, "api.person.notesUpdateResponse": { "title": "Person Notes Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "manager": { "properties": { "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note.simple" } } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } } }, "type": "object" }, "api.person.store": { "title": "Person Store Request Body", "required": [ "firstName", "lastName", "companyRecordName", "companyRecordId", "companyName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true }, "companyRecordName": { "description": "The name of an existing company record to add the person to. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "companyRecordId": { "description": "The ID of a company to add the person to.", "type": "integer", "example": 1234 }, "companyName": { "description": "The company the person works for, which will not be associated with an existing company. (Required if `companyRecordName` or `companyRecordId` are not set)", "type": "string", "example": "Amazon" }, "department": { "type": "string", "example": "Finance" }, "title": { "type": "string", "example": "Managing Director" }, "positionType": { "type": "string", "default": "permanent", "enum": [ "permanent", "interim", "ned", "parttime", "temporary", "contract", "other" ], "example": "permanent" }, "career": { "description": "The career ID of the primary position. Careers and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "industry": { "description": "The industry ID of the primary position. Industries and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "location": { "description": "The location ID of the primary position. Locations and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "startDate": { "type": "string", "example": "1998-04-30" }, "endDate": { "type": "string", "example": "2005-06-23" }, "startMonthUnknown": { "description": "If the start month is unknown then put any month and day in the `startDate` field and set this field to `true`", "type": "boolean", "default": false }, "endMonthUnknown": { "description": "If the end month is unknown then put any month and day in the `endDate` field and set this field to `true`", "type": "boolean", "default": false }, "summary": { "type": "string", "example": "Managed several team members to meet a strict schedule." }, "assignmentId": { "description": "The ID of an assignment that the person will be added to as a candidate", "type": "integer" }, "assignmentName": { "description": "The name of an assignment to add the person to as a candidate. If an assignment with that name does not exist then a new one will be created.", "type": "string" }, "lists": { "description": "An array of ids of the the lists that the person is in", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.person.update": { "title": "Person Update Request Body", "required": [ "firstName", "lastName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true } }, "type": "object" }, "api.person.emailStoreRequest": { "title": "Person Email Store Request Body", "properties": { "address": { "type": "string", "example": "me@example.com" }, "label": { "$ref": "#/components/schemas/api.email.label" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "type": "object" }, "api.person.phoneStoreRequest": { "title": "Person Phone Number Store Request Body", "properties": { "number": { "type": "string", "example": "01234 567890" }, "label": { "$ref": "#/components/schemas/api.phone.label" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "type": "object" }, "api.person.pipelineUpdateRequest": { "title": "Candidates Tags Store Request Body", "properties": { "candidates": { "description": "An array of person IDs that will have the specified tags added.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "tags": { "description": "An array of pipeline tag IDs that will be added to the candidates.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" }, "api.person.pipelineUpdateResponse": { "title": "Candidates Tags Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "candidate": { "properties": { "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } } }, "type": "object" }, "api.person.tagsUpdateRequest": { "title": "Person Tags Store Request Body", "properties": { "people": { "description": "An array of person IDs that will have the specified tags added.", "type": "array", "items": { "type": "integer", "example": 4321 } }, "tags": { "description": "An array of person tag IDs that will be added to the people.", "type": "array", "items": { "type": "integer", "example": 5678 } } }, "type": "object" }, "api.person.tagsUpdateResponse": { "title": "Person Tags Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 4321 }, "fullName": { "type": "string", "example": "Jane Doe" }, "manager": { "properties": { "tags": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 5678 }, "text": { "type": "string", "example": "VIP" }, "color": { "type": "string", "example": "#abcabc" }, "default": { "type": "boolean" }, "order": { "type": "integer" }, "type": { "type": "string", "example": "person" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } } }, "type": "object" }, "api.person.candidatesUpdateRequest": { "title": "Candidates Store Request Body", "properties": { "candidates": { "description": "An array of person IDs that will be added to the assignment.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "assignmentId": { "description": "The ID of an assignment to add the candidates to.", "type": "integer", "example": 1234 }, "assignmentName": { "description": "Can be used instead of `assignmentId` and will search for an assignment with the name or create if it doesn't exist.", "type": "string", "example": "CTO" } }, "type": "object" }, "api.person.candidatesUpdateResponse": { "title": "Candidates Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "counts": { "properties": { "relationships": { "properties": { "candidatesLists": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.listPeopleUpdateResponse": { "title": "List People Update Response", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "John Smith" } }, "type": "object" } }, "api.project.store": { "title": "Project Store Request Body", "required": [ "name", "owner", "_type", "label" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "label": { "type": "string", "enum": [ "assignment", "opportunity" ], "example": "assignment" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "ownerId": { "type": "integer", "example": "1234" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.project.update": { "title": "Project Update Request Body", "required": [ "name", "owner", "_type", "label" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "label": { "type": "string", "enum": [ "assignment", "opportunity" ], "example": "assignment" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "ownerId": { "type": "integer", "example": "1234" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" } }, "type": "object" }, "api.billing.storeRequest": { "title": "Task Store Request Body", "properties": { "contactId": { "type": "integer", "example": "123" } }, "type": "object" }, "api.v2.company.store": { "title": "Company Store Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info' or 'addresses', or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "assignmentId": { "type": "integer", "example": "1234", "nullable": true }, "assignmentName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v2.company.update": { "title": "Company Store Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info' or 'addresses', or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "assignmentId": { "type": "integer", "example": "1234", "nullable": true }, "assignmentName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } } }, "type": "object" }, "api.v2.listPeopleUpdateResponse": { "title": "List People Update Response", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "John Smith" } }, "type": "object" } }, "api.v2.person.candidatesUpdateRequest": { "title": "Candidates Store Request Body", "properties": { "candidates": { "description": "An array of person IDs that will be added to the assignment.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "assignmentId": { "description": "The ID of an assignment to add the candidates to.", "type": "integer", "example": 1234 }, "assignmentName": { "description": "Can be used instead of `assignmentId` and will search for an assignment with the name or create if it doesn't exist.", "type": "string", "example": "CTO" } }, "type": "object" }, "api.v2.person.candidatesUpdateResponse": { "title": "Candidates Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "counts": { "properties": { "relationships": { "properties": { "candidatesLists": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.v2.person.store": { "title": "Person Store Request Body", "required": [ "firstName", "lastName", "companyRecordName", "companyRecordId", "companyName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true }, "companyRecordName": { "description": "The name of an existing company record to add the person to. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "companyRecordId": { "description": "The ID of a company to add the person to.", "type": "integer", "example": 1234 }, "companyName": { "description": "The company the person works for, which will not be associated with an existing company. (Required if `companyRecordName` or `companyRecordId` are not set)", "type": "string", "example": "Amazon" }, "department": { "type": "string", "example": "Finance" }, "title": { "type": "string", "example": "Managing Director" }, "positionType": { "type": "string", "default": "permanent", "enum": [ "permanent", "interim", "ned", "parttime", "temporary", "contract", "other" ], "example": "permanent" }, "career": { "description": "The career ID of the primary position. Careers and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "industry": { "description": "The industry ID of the primary position. Industries and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "location": { "description": "The location ID of the primary position. Locations and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "startDate": { "type": "string", "example": "1998-04-30" }, "endDate": { "type": "string", "example": "2005-06-23" }, "startMonthUnknown": { "description": "If the start month is unknown then put any month and day in the `startDate` field and set this field to `true`", "type": "boolean", "default": false }, "endMonthUnknown": { "description": "If the end month is unknown then put any month and day in the `endDate` field and set this field to `true`", "type": "boolean", "default": false }, "summary": { "type": "string", "example": "Managed several team members to meet a strict schedule." }, "assignmentId": { "description": "The ID of an assignment that the person will be added to as a candidate", "type": "integer" }, "assignmentName": { "description": "The name of an assignment to add the person to as a candidate. If an assignment with that name does not exist then a new one will be created.", "type": "string" }, "lists": { "description": "An array of ids of the the lists that the person is in", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v2.person.update": { "title": "Person Update Request Body", "required": [ "firstName", "lastName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true } }, "type": "object" }, "api.v2.billing.storeRequest": { "title": "Task Store Request Body", "properties": { "contactId": { "type": "integer", "example": "123" } }, "type": "object" }, "api.v3.company.store": { "title": "Company Store Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info'(Updates all fields except addresses), 'addresses'(Only updates addresses), or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "projectId": { "type": "integer", "example": "1234", "nullable": true }, "projectName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v3.company.update": { "title": "Company Store Request Body", "required": [ "name", "owner", "_type" ], "properties": { "_type": { "description": "Must be 'info'(Updates all fields except addresses), 'addresses'(Only updates addresses), or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "projectId": { "type": "integer", "example": "1234", "nullable": true }, "projectName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } } }, "type": "object" }, "api.v3.projectContactStoreRequest": { "title": "Project Contacts Store Request Body", "required": [ "contactId" ], "properties": { "contactId": { "description": "The ID of a contact to add ", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v3.person.store": { "title": "Person Store Request Body", "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "aliases": { "type": "array", "items": { "type": "string", "example": "Doey" } }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true }, "companyRecordName": { "description": "The name of an existing company record to add the person to. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "companyRecordId": { "description": "The ID of a company to add the person to.", "type": "integer", "example": 1234 }, "companyName": { "description": "The company the person works for, which will not be associated with an existing company. (Required if `companyRecordName` or `companyRecordId` are not set)", "type": "string", "example": "Amazon" }, "department": { "type": "string", "example": "Finance" }, "title": { "type": "string", "example": "Managing Director" }, "positionType": { "type": "string", "default": "permanent", "enum": [ "permanent", "interim", "ned", "parttime", "temporary", "contract", "other" ], "example": "permanent" }, "career": { "description": "The career ID of the primary position. Careers and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "industry": { "description": "The industry ID of the primary position. Industries and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "location": { "description": "The location ID of the primary position. Locations and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "startDate": { "type": "string", "example": "1998-04-30" }, "endDate": { "type": "string", "example": "2005-06-23" }, "startMonthUnknown": { "description": "If the start month is unknown then put any month and day in the `startDate` field and set this field to `true`", "type": "boolean", "default": false }, "endMonthUnknown": { "description": "If the end month is unknown then put any month and day in the `endDate` field and set this field to `true`", "type": "boolean", "default": false }, "summary": { "type": "string", "example": "Managed several team members to meet a strict schedule." }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.storeRequest.project" } } }, "type": "object" }, "api.v3.person.update": { "title": "Person Update Request Body", "required": [ "firstName", "lastName", "companyRecordName", "companyRecordId", "companyName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "aliases": { "type": "array", "items": { "type": "string", "example": "Doey" } }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true } }, "type": "object" }, "api.v3.person.pipelineUpdateRequest": { "title": "Candidates Tags Store Request Body", "properties": { "candidates": { "description": "An array of person IDs that will have the specified tags added.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "tags": { "description": "An array of pipeline tag IDs that will be added to the candidates.", "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" }, "api.v3.person.pipelineUpdateResponse": { "title": "Candidates Tags Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "candidate": { "properties": { "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } } }, "type": "object" }, "api.v3.person.candidatesUpdateRequest": { "title": "Candidates Store Request Body", "required": [ "candidates", "label" ], "properties": { "candidates": { "description": "An array of person IDs that will be added to the project.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "projectId": { "description": "The ID of a project to add the candidates to.", "type": "integer", "example": 1234 }, "projectName": { "description": "Can be used instead of `projectId` and will search for a project with the name or create if it doesn't exist.", "type": "string", "example": "CTO" }, "label": { "description": "The type of project to add the candidates to.", "type": "string", "enum": [ "assignment", "opportunity", "list" ] } }, "type": "object" }, "api.v3.project.default.api.person.candidatesUpdateResponse": { "title": "Candidates Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "counts": { "properties": { "relationships": { "properties": { "assignmentsAsCandidate": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.v3.project.store": { "title": "Project Store Request Body", "required": [ "name", "ownerId", "_type", "label" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "label": { "type": "string", "enum": [ "assignment", "opportunity", "list" ], "example": "assignment" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "ownerId": { "type": "integer", "example": "1234" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v3.project.update": { "title": "Project Store Request Body", "required": [ "name", "ownerId", "_type" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "ownerId": { "type": "integer", "example": "1234" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" } }, "type": "object" }, "api.v4.company.store": { "title": "Company Store Request Body", "required": [ "name", "_type" ], "properties": { "_type": { "description": "Must be 'info'(Updates all fields except addresses), 'addresses'(Only updates addresses), or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "projectId": { "type": "integer", "example": "1234", "nullable": true }, "projectName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v4.company.update": { "title": "Company Store Request Body", "required": [ "name", "_type" ], "properties": { "_type": { "description": "Must be 'info'(Updates all fields except addresses), 'addresses'(Only updates addresses), or 'all'", "type": "string", "example": "info" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" }, "description": { "type": "string", "example": "The description of the company", "nullable": true }, "division": { "type": "string", "example": "The division or subsidiary of the company", "nullable": true }, "size": { "type": "string", "example": "The size of the company", "nullable": true }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/123", "nullable": true }, "specialities": { "type": "string", "example": "The specialities of the company", "nullable": true }, "email": { "type": "string", "example": "me@example.com", "nullable": true }, "phone": { "type": "string", "example": "+123 456 789", "nullable": true }, "projectId": { "type": "integer", "example": "1234", "nullable": true }, "projectName": { "type": "string", "example": "Chief Technology Officer - London", "nullable": true }, "addresses": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "hq", "billing", "subsidiary", "work" ], "example": "hq" }, "building": { "type": "string", "example": "Catton Court" }, "street": { "type": "string", "example": "Oak Ridge" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "country": { "type": "string", "example": "Ireland" } }, "type": "object" } } }, "type": "object" }, "api.v4.listPeopleUpdateResponse": { "title": "List People Update Response", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "fullName": { "type": "string", "example": "John Smith" } }, "type": "object" } }, "api.v4.projectContactStoreRequest": { "title": "Project Contacts Store Request Body", "required": [ "contactId" ], "properties": { "contactId": { "description": "The ID of a contact to add ", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v4.person.store": { "title": "Person Store Request Body", "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" }, "companyRecordName": { "description": "The name of an existing company record to add the person to. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "companyRecordId": { "description": "The ID of a company to add the person to.", "type": "integer", "example": 1234 }, "companyName": { "description": "The company the person works for, which will not be associated with an existing company. (Required if `companyRecordName` or `companyRecordId` are not set)", "type": "string", "example": "Amazon" }, "department": { "type": "string", "example": "Finance" }, "title": { "type": "string", "example": "Managing Director" }, "positionType": { "type": "string", "default": "permanent", "enum": [ "permanent", "interim", "ned", "parttime", "temporary", "contract", "other" ], "example": "permanent" }, "career": { "description": "The career ID of the primary position. Careers and their IDs can be found using the `categories` API.", "type": "integer" }, "industry": { "description": "The industry ID of the primary position. Industries and their IDs can be found using the `categories` API.", "type": "integer" }, "location": { "description": "The location ID of the primary position. Locations and their IDs can be found using the `categories` API.", "type": "integer" }, "startDate": { "type": "string", "example": "1998-04-30" }, "endDate": { "type": "string", "example": "2005-06-23" }, "startMonthUnknown": { "description": "If the start month is unknown then put any month and day in the `startDate` field and set this field to `true`", "type": "boolean", "default": false }, "endMonthUnknown": { "description": "If the end month is unknown then put any month and day in the `endDate` field and set this field to `true`", "type": "boolean", "default": false }, "summary": { "type": "string", "example": "Managed several team members to meet a strict schedule." }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.storeRequest.project" } } }, "type": "object" }, "api.v4.person.update": { "title": "Person Update Request Body", "required": [ "firstName", "lastName", "companyRecordName", "companyRecordId", "companyName" ], "properties": { "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "headline": { "type": "string", "example": "I work well in a team." }, "links": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" } }, "type": "object" } }, "phones": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "number": { "type": "string", "example": "+123 456 789" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "emails": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "address": { "type": "string", "example": "me@example.com" }, "isDefault": { "type": "boolean" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" } }, "type": "object" } }, "addresses": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" } }, "type": "object" } }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" } }, "type": "object" }, "api.v4.person.candidatesUpdateRequest": { "title": "Candidates Store Request Body", "required": [ "candidates", "label" ], "properties": { "candidates": { "description": "An array of person IDs that will be added to the project.", "type": "array", "items": { "type": "integer", "example": 1234 } }, "projectId": { "description": "The ID of a project to add the candidates to.", "type": "integer", "example": 1234 }, "projectName": { "description": "Can be used instead of `projectId` and will search for a project with the name or create if it doesn't exist.", "type": "string", "example": "CTO" }, "label": { "description": "The type of project to add the candidates to.", "type": "string", "enum": [ "assignment", "opportunity", "list" ] } }, "type": "object" }, "api.v4.project.default.api.person.candidatesUpdateResponse": { "title": "Candidates Store Response", "properties": { "updated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "counts": { "properties": { "relationships": { "properties": { "assignmentsAsCandidate": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "notUpdated": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.v4.project.store": { "title": "Project Store Request Body", "required": [ "name", "_type", "label" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "label": { "type": "string", "enum": [ "assignment", "opportunity", "list" ], "example": "assignment" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "careers": { "description": "An array of role classification ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "listId": { "description": "The ID of the list", "type": "integer" }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.store" } } }, "type": "object" }, "api.v4.project.update": { "title": "Project Store Request Body", "required": [ "name", "_type" ], "properties": { "leadId": { "description": "The ID of the person to add as project contact", "type": "integer", "example": "1234" }, "_type": { "type": "string", "enum": [ "info", "custom" ], "example": "info" }, "name": { "type": "string", "example": "Regional Manager" }, "projectId": { "type": "string", "example": "EZ123" }, "description": { "type": "string", "example": "The description of the assignment", "nullable": true }, "companyId": { "description": "The ID of a company to add to project.", "type": "string", "example": 1234 }, "companyName": { "description": "The name of an existing company record to add to the project. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "owner": { "required": [ "ownerId" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "tags": { "description": "An array of ownership tag ids", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" }, "industries": { "description": "An array of industry ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "careers": { "description": "An array of role classification ids", "type": "array", "items": { "type": "integer", "example": 1234 }, "nullable": true }, "listId": { "description": "The ID of the list", "type": "integer" }, "startDate": { "description": "For assignments only. The date the assignment starts.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "endDate": { "description": "For assignments only. The date the assignment is ends.", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "probability": { "type": "integer", "example": "30" } }, "type": "object" }, "api.v4.billing.storeRequest": { "title": "Task Store Request Body", "properties": { "contactId": { "type": "integer", "example": "123" } }, "type": "object" }, "api.candidate.profilePicture.storeRequest": { "title": "Profile Picture Store Request Body", "required": [ "image" ], "properties": { "image": { "description": "The profile picture file. Accepted MIME types: image/jpeg, image/png, image/gif, image/webp.", "type": "string", "format": "binary" } }, "type": "object" }, "api.fixedFee.storeRequest": { "title": "Fixed Fee Store Request Body", "required": [ "amount", "recipient", "tag" ], "properties": { "amount": { "$ref": "#/components/schemas/api.currencyAmount" }, "billingId": { "type": "integer", "example": "123" }, "briefId": { "type": "integer", "example": "123" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "id": { "type": "integer", "example": "123" }, "note": { "type": "string", "example": "This is a note" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "enum": [ "candidate", "person", "officeGroup" ], "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" }, "api.invoice.storeRequest": { "title": "Invoice Store Request Body", "required": [ "items", "currency", "invoiceAt", "tag" ], "properties": { "refNumber": { "description": "Class InvoiceStore", "type": "string", "example": "inv1234" }, "invoiceNumber": { "description": "If using automatic numbering, input the appropriate number pattern to be used and the next available number will be added to the invoice.", "type": "string", "example": "UK001" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "invoicedAt": { "type": "string", "example": "2022-05-30" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "items": { "type": "array", "items": { "properties": { "tag": { "description": "The tag for the invoice item", "type": "integer", "example": "12" }, "description": { "type": "string", "example": "Placement Fee" }, "amount": { "$ref": "#/components/schemas/api.currencyAmount" } }, "type": "object" } }, "owner": { "properties": { "id": { "type": "integer", "example": "123" }, "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" } }, "type": "object" }, "tag": { "description": "The tag for the invoice", "type": "integer", "example": "12" }, "currency": { "$ref": "#/components/schemas/api.currency" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "30" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.invoice.lock": { "title": "Invoice Lock Request Body", "required": [ "dueDate", "invoiceNumber", "templateId", "locale", "type" ], "properties": { "dueDate": { "description": "Class LockInvoice", "type": "string", "example": "2022-05-30" }, "invoiceNumber": { "type": "string", "example": "EZ001" }, "templateId": { "type": "integer", "example": "123" }, "locale": { "type": "string", "example": "en" }, "type": { "type": "string", "enum": [ "word", "pdf" ], "example": "pdf" } }, "type": "object" }, "api.revenue.storeRequest": { "title": "Revenue Store Request Body", "required": [ "amount", "currency", "date", "tag", "probability" ], "properties": { "amount": { "$ref": "#/components/schemas/api.currencyAmount" }, "date": { "type": "string", "example": "2022-05-30" }, "tag": { "type": "integer", "example": "123" }, "probability": { "type": "integer", "example": "50" }, "billingId": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "owner": { "properties": { "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" }, "id": { "type": "integer", "example": "123" } }, "type": "object" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "30" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.customValue.storeRequest": { "title": "Custom Value Update Request Body", "required": [ "fieldId", "value" ], "properties": { "customValues": { "description": "Class CustomValueRequest", "type": "array", "items": { "$ref": "#/components/schemas/api.customValue.update" } }, "modelId": { "description": "The ID of the model to which the custom value is being added/updated.", "type": "integer", "example": 1234 } }, "type": "object" }, "api.document.default": { "title": "Document Request Body", "required": [ "files[]" ], "properties": { "files[]": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" }, "api.importEmail.default": { "title": "Person Email Request Body", "required": [ "from", "to", "subject", "text" ], "properties": { "from": { "description": "The sender's email address", "type": "string", "example": "joe@example.com" }, "to": { "description": "The email address of the recipient. Separate multiple email addresses using comma. (e.g. \"person1@example.com, anotherperson@example.com\")", "type": "string", "example": "person1@example.com, anotherperson@example.com" }, "cc": { "description": "The email address of the cc recipient. Separate multiple email addresses using comma eg (e.g. \"person1@example.com, anotherperson@example.com\")", "type": "string", "example": "person1@example.com, anotherperson@example.com" }, "bcc": { "description": "The email address of the bcc recipient. Separate multiple email addresses using comma. (e.g. \"person1@example.com, anotherperson@example.com\")", "type": "string", "example": "person1@example.com, anotherperson@example.com" }, "subject": { "description": "The subject of the email", "type": "string", "example": "Meeting Arrangements for Thursday" }, "body": { "description": "The body of the email", "type": "string", "example": "Dear Sir, Thank you for the ..." }, "microsoftGraphId": { "description": "The Microsoft Graph id of the email", "type": "string", "example": "AQMkADAwATMwMAItNjFiYgAtZmQ4NS0wMAI..." }, "microsoftGraphMessageId": { "description": "The Microsoft Graph message id of the email", "type": "string", "example": "<TYZPR02MB560C3D7B09@TY45645617.test.prod.outlook.com>" }, "createdAt": { "description": "The date and time the email was created", "type": "string", "example": "2023-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.language.storeRequest": { "title": "Language Request Body", "required": [ "code", "fluency" ], "properties": { "code": { "description": "The language code", "type": "string", "example": "en" }, "fluency": { "description": "Indicates proficiency in the language: 1 = Native, 2 = Fluent, 3 = Conversational, 4 = Basic", "type": "integer", "example": "2" } }, "type": "object" }, "api.list.storeRequest": { "title": "List Store Request Body", "required": [ "name", "owner" ], "properties": { "name": { "description": "Class Store", "type": "string", "example": "ListA" }, "owner": { "type": "integer", "example": "1234" }, "pipeline": { "$ref": "#/components/schemas/api.list.pipelineTask" } }, "type": "object" }, "api.offlimits.agreement.storeRequest": { "title": "Off-limit Agreement Request Body", "description": "A note regarding the off-limits agreement", "properties": { "endDate": { "description": "The date you want the off-limits agreeement to end", "type": "string", "example": "2022-07-28" }, "filter": { "description": "The search term. Required if you are passing through 'companies'.", "type": "string", "example": "Amazon" }, "constraint": { "description": "The search constraint of the filter. Required if you are passing through 'companies'.", "type": "string", "enum": [ "begins", "contains", "exact", "contains-exact" ], "example": "contains" }, "offLimitItemId": { "description": "The id of the person you are setting an off-limits agreement to. Required if you are passing through 'people'.", "type": "integer", "example": "14799" }, "description": { "type": "string", "example": "Off Limit Agreement with Amazon" } }, "type": "object" }, "api.education.storeRequest": { "title": "Person Education Request Body", "required": [ "degree", "school" ], "properties": { "primary": { "description": "Class Education Request", "type": "boolean" }, "degree": { "type": "string", "example": "First Class Honours" }, "field": { "type": "string", "example": "French Literature" }, "school": { "type": "string", "example": "Oxford University" }, "startDate": { "type": "integer", "example": 2011 }, "endDate": { "description": "Enter year. Otherwise if current, then enter 'present'", "type": "integer", "example": 2018 }, "summary": { "type": "string", "example": "Education Summary" } }, "type": "object" }, "api.position.storeRequest": { "title": "Person Position Request Body", "required": [ "companyRecordName", "companyRecordId", "companyName" ], "properties": { "primary": { "description": "Class Position Request", "type": "boolean" }, "positionType": { "type": "string", "default": "permanent", "enum": [ "permanent", "interim", "ned", "parttime", "temporary", "contract", "other" ], "example": "permanent" }, "companyName": { "description": "The company the person works for, which will not be associated with an existing company. (Required if `companyRecordName` or `companyRecordId` are not set)", "type": "string", "example": "Amazon" }, "companyRecordName": { "description": "The name of an existing company record to add the person to. (A new company record will be created if the company does not exist)", "type": "string", "example": "Amazon" }, "companyRecordId": { "description": "The ID of a company to add the person to.", "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Director of Communication" }, "teamSizeId": { "$ref": "#/components/schemas/api.teamSizeId" }, "career": { "description": "The career ID of the position. Careers and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "industry": { "description": "The industry ID of the position. Industries and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "location": { "description": "The location ID of the position. Locations and their IDs can be found using the `categories` API.", "type": "integer", "example": 1234 }, "summary": { "type": "string", "example": "Summary of the position" }, "department": { "type": "string", "example": "Finance" }, "startDate": { "type": "string", "example": "2011-08-14" }, "endDate": { "type": "string", "example": "2018-03-25" }, "achievements": { "type": "array", "items": { "type": "string", "example": "Managed all the finances." } }, "skills": { "type": "array", "items": { "type": "string", "example": "Good at managing finances." } }, "companyTypes": { "type": "array", "items": { "description": "The company types IDs of the position. Company Types and their IDs can be found using the `categories` API.", "type": "integer" } }, "startMonthUnknown": { "description": "If the start month is unknown then put any month and day in the `startDate` field and set this field to `true`", "type": "boolean", "default": false }, "endMonthUnknown": { "description": "If the end month is unknown then put any month and day in the `endDate` field and set this field to `true`", "type": "boolean", "default": false } }, "type": "object" }, "api.positions.multiple": { "title": "Person multiple Positions Request Body", "description": "The body for creating and updating multiple positions for a person's", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.position.storeRequest" } } }, "type": "object" }, "api.currentStatus.storeRequest": { "title": "Person Current Status Request Body", "required": [ "positionType", "status" ], "properties": { "positionType": { "description": "Type of position", "type": "string", "enum": [ "permanent", "interim", "parttime", "contract", "temporary", "ned", "other" ], "example": "permanent" }, "nedClassificationId": { "description": "Classification of NED role if positionType is ned", "type": "integer", "example": 1234 }, "careers": { "description": "An array of career IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "industries": { "description": "An array of industry IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "locations": { "description": "An array of location IDs", "type": "array", "items": { "type": "integer", "example": 1234 } }, "status": { "description": "A scale from 0 to 4 indicating how actively the individual is looking for a new job. 0 is Not looking, 4 is actively looking.", "type": "integer", "enum": [ 0, 1, 2, 3, 4 ], "example": 1 } }, "type": "object" }, "api.meeting.default": { "title": "Meeting Request Body", "required": [ "title", "timezone", "date", "end", "tag", "private", "sensitivity", "allDay", "includeDetails", "includeName" ], "properties": { "title": { "description": "The subject of the meeting", "type": "string", "example": "Q3 Target Review" }, "owners": { "description": "An array of attendee person ids", "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.owners" } }, "note": { "description": "A simple note for the meeting", "type": "string", "example": "John will attend!", "nullable": true }, "timezone": { "description": "Set a timezone", "type": "string", "example": "Europe/London" }, "date": { "description": "Set a start date and time for the meeting", "type": "string", "example": "2023-07-20 13:00:00" }, "end": { "description": "Set an end date and time for the meeting", "type": "string", "example": "2023-07-20 14:00:00" }, "address": { "description": "Set a location for the meeting", "type": "string", "example": "London Office" }, "agenda": { "description": "Set an agenda for the meeting", "type": "string", "example": "We will discuss progress during Q3" }, "tag": { "description": "The ID of the status tag", "type": "integer", "example": "1234" }, "private": { "description": "Make private in Ezekia", "type": "boolean", "example": true }, "sensitivity": { "description": "Make private in Outlook", "type": "boolean", "example": true }, "allDay": { "description": "Is this meeting all day?", "type": "boolean", "example": true }, "details": { "description": "Add additional details about the meeting", "type": "string", "example": "We will review Q3 and discuss Q4", "nullable": true }, "includeDetails": { "description": "Include additional details in the email", "type": "boolean", "example": true }, "includeName": { "description": "Include person name in the email", "type": "boolean", "example": true }, "sendInvite": { "description": "Send an invite to the attendees. By default, this is set to true. To disable it, set it to false.", "type": "boolean", "example": false }, "microsoftGraphIntegrationId": { "description": "Add the Microsoft Graph integration ID (if applicable)", "type": "integer", "example": "2", "nullable": true }, "channels": { "description": "Add the type and id to associate the message with", "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.channels" }, "nullable": true } }, "type": "object" }, "api.meeting.channels": { "title": "Meeting Channels Request Body", "description": "The data type name which the meeting belongs to", "properties": { "id": { "description": "The data type id which the meeting belongs to", "type": "integer", "example": "1234" }, "label": { "type": "string", "example": "assignment" } }, "type": "object", "enum": [ "assignment", "opportunity", "person", "company" ] }, "api.meeting.owners": { "title": "Meeting Owners Request Body", "properties": { "id": { "type": "integer", "example": 1234, "nullable": true }, "type": { "type": "string", "enum": [ "candidate", "person" ], "example": "candidate", "nullable": true }, "fullname": { "type": "string", "example": "Jane Doe", "nullable": true }, "email": { "type": "string", "example": "me@example.com" } }, "type": "object" }, "api.meeting.updatePinned": { "title": "Meeting Update Pinned", "required": [ "pinned" ], "properties": { "pinned": { "description": "Set whether the meeting should be pinned or not", "type": "boolean", "example": true } }, "type": "object" }, "api.note.storeRequest": { "title": "Person Update Request Body", "properties": { "noteText": { "description": "Class NoteRequest", "type": "string", "example": "Added from email" }, "tags": { "type": "array", "items": { "type": "integer", "example": 1234 } }, "context": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "type": { "type": "string", "enum": [ "executive", "person", "client", "company", "assignment", "opportunity" ] } }, "type": "object" } }, "ownerId": { "description": "The user id of the owner of the note if not provided the current user will be used", "type": "integer", "example": 1234 } }, "type": "object" }, "api.task.storeRequest": { "title": "Task Store", "allOf": [ { "$ref": "#/components/schemas/api.task.default" }, { "properties": { "priority": { "description": "Set a priority for the task", "type": "integer", "example": 1 } }, "type": "object" } ] }, "api.task.update": { "title": "Task Update", "allOf": [ { "$ref": "#/components/schemas/api.task.default" } ] }, "api.task.updateDone": { "title": "Task Update Done", "required": [ "done" ], "properties": { "done": { "description": "Set whether the task has been completed or not", "type": "boolean", "example": true } }, "type": "object" }, "api.task.updatePriority": { "title": "Task Update Priority", "required": [ "priority" ], "properties": { "priority": { "description": "Set the the priority level of the task (4 no priority, 3 low, 2 medium, 1 high)", "type": "integer", "example": 4 } }, "type": "object", "enum": [ 1, 2, 3, 4 ] }, "api.task.updatePinned": { "title": "Task Update Pinned", "required": [ "pinned" ], "properties": { "pinned": { "description": "Set whether the task should be pinned or not", "type": "boolean", "example": true } }, "type": "object" }, "api.task.default": { "title": "Task Request Body", "required": [ "title", "owners", "timezone", "date", "private", "tag" ], "properties": { "title": { "description": "The title of the task", "type": "string", "example": "Arrange meeting for Thursday" }, "owners": { "description": "An array of assigned person ids", "type": "array", "items": { "type": "integer", "example": 4321 } }, "note": { "description": "A simple note for the task", "type": "string", "example": "John will attend!" }, "timezone": { "description": "Set a timezone for the due date", "type": "string", "example": "Europe/London" }, "date": { "description": "Set a due date for the task", "type": "string", "example": "2023-07-20 13:00:00" }, "tag": { "description": "The ID of the status tag", "type": "integer", "example": "1234" }, "private": { "description": "Is the task private?", "type": "boolean" }, "recursion": { "oneOf": [ { "$ref": "#/components/schemas/api.task.recursion" } ], "nullable": true, "description": "Add recurring details", "type": "object" }, "channels": { "description": "Add the type and id to associate the task with", "type": "array", "items": { "$ref": "#/components/schemas/api.task.channels" }, "nullable": true } }, "type": "object" }, "api.task.channels": { "title": "Task Channels Request Body", "description": "The data type name which the task belongs to", "properties": { "id": { "description": "The data type id which the task belongs to", "type": "integer", "example": "1234" }, "label": { "type": "string", "example": "assignment" } }, "type": "object", "enum": [ "assignment", "opportunity", "person", "company" ] }, "api.opportunities.completion.storeRequest": { "title": "Opportunity Completion Request Body", "properties": { "completion": { "description": "The completion percentage of the opportunity. The range must be between 0 and 100%", "type": "integer", "maximum": 100, "minimum": 0, "example": "35" } }, "type": "object" }, "api.v3.fixedFee.storeRequest": { "title": "Fixed Fee Store Request Body", "required": [ "total", "recipient", "tag" ], "properties": { "total": { "properties": { "amount": { "description": "Class FixedFeeStore", "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "billingId": { "type": "integer", "example": "123" }, "briefId": { "type": "integer", "example": "123" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "id": { "type": "integer", "example": "123" }, "note": { "type": "string", "example": "This is a note" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "enum": [ "candidate", "person", "officeGroup" ], "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" }, "api.v3.invoice.storeRequest": { "title": "Invoice Store Request Body", "required": [ "items", "total", "invoiceAt", "tag" ], "properties": { "refNumber": { "description": "Class InvoiceStore", "type": "string", "example": "inv1234" }, "invoiceNumber": { "description": "If using automatic numbering, input the appropriate number pattern to be used and the next available number will be added to the invoice.", "type": "string", "example": "UK001" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "invoicedAt": { "type": "string", "example": "2022-05-30" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "items": { "type": "array", "items": { "properties": { "tag": { "description": "The tag for the invoice item", "type": "integer", "example": "12" }, "description": { "type": "string", "example": "Placement Fee" }, "amount": { "$ref": "#/components/schemas/api.currencyAmount" } }, "type": "object" } }, "owner": { "properties": { "id": { "type": "integer", "example": "123" }, "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" } }, "type": "object" }, "tag": { "description": "The tag for the invoice", "type": "integer", "example": "12" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "25" }, "amount": { "type": "integer", "example": "25.50" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.v3.revenue.storeRequest": { "title": "Revenue Store Request Body", "required": [ "total", "date", "tag", "probability" ], "properties": { "total": { "properties": { "amount": { "description": "Class RevenueStore", "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "date": { "type": "string", "example": "2022-05-30" }, "tag": { "type": "integer", "example": "123" }, "probability": { "type": "integer", "example": "50" }, "billingId": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "owner": { "properties": { "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" }, "id": { "type": "integer", "example": "123" } }, "type": "object" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "25" }, "amount": { "type": "integer", "example": "25.50" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.v3.consultant.request.store": { "title": "Adding a Consultant Request Body", "required": [ "userId" ], "properties": { "userId": { "description": "Consultant Store Request", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v3.officeGroup.request.store": { "title": "Adding an Office Group Request Body", "required": [ "id" ], "properties": { "id": { "description": "Office Group Store Request", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v3.region.request.store": { "title": "Adding a Region Request Body", "required": [ "id" ], "properties": { "id": { "description": "Region Store Request", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v3.person.storeRequest.project": { "title": "People store projects", "properties": { "projectId": { "type": "integer", "example": 1234 }, "projectName": { "type": "string", "example": "Project name" }, "projectType": { "type": "string", "enum": [ "assignment", "opportunity", "list" ], "example": "assignment" } }, "type": "object" }, "api.v3.project.completion.updateRequest": { "title": "Project Completion Request Body", "required": [ "completion" ], "properties": { "completion": { "description": "The completion percentage of the project. The range must be between 0 and 100%", "type": "integer", "maximum": 100, "minimum": 0, "example": "35" } }, "type": "object" }, "api.v3.project.action.update": { "title": "Project Action Update Request Body", "required": [ "actions" ], "properties": { "actions": { "description": "An array of person IDs that will have the specified tags added.", "type": "array", "items": { "properties": { "id": { "description": "Class Update Request", "type": "integer", "example": 1234 }, "tag": { "type": "integer", "example": 1234 }, "days": { "type": "integer", "example": 22 }, "taskName": { "type": "string", "example": "The name of the task in the pipeline" }, "repeating": { "type": "boolean" }, "emailAlert": { "type": "boolean" }, "assignee": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.v4.fixedFee.storeRequest": { "title": "Fixed Fee Store Request Body", "required": [ "total", "recipient", "tag" ], "properties": { "total": { "properties": { "amount": { "description": "Class FixedFeeStore", "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "billingId": { "type": "integer", "example": "123" }, "briefId": { "type": "integer", "example": "123" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "id": { "type": "integer", "example": "123" }, "note": { "type": "string", "example": "This is a note" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "enum": [ "candidate", "person", "officeGroup" ], "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" }, "api.v4.invoice.storeRequest": { "title": "Invoice Store Request Body", "required": [ "items", "total", "invoiceAt", "tag" ], "properties": { "refNumber": { "description": "Class InvoiceStore", "type": "string", "example": "inv1234" }, "invoiceNumber": { "description": "If using automatic numbering, input the appropriate number pattern to be used and the next available number will be added to the invoice.", "type": "string", "example": "UK001" }, "paidAt": { "type": "string", "example": "2022-05-30" }, "invoicedAt": { "type": "string", "example": "2022-05-30" }, "dueDate": { "type": "string", "example": "2022-05-30" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "items": { "type": "array", "items": { "properties": { "tag": { "description": "The tag for the invoice item", "type": "integer", "example": "12" }, "description": { "type": "string", "example": "Placement Fee" }, "amount": { "$ref": "#/components/schemas/api.currencyAmount" } }, "type": "object" } }, "owner": { "properties": { "id": { "type": "integer", "example": "123" }, "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" } }, "type": "object" }, "tag": { "description": "The tag for the invoice", "type": "integer", "example": "12" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "25" }, "amount": { "type": "integer", "example": "25.50" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.v4.revenue.storeRequest": { "title": "Revenue Store Request Body", "required": [ "total", "date", "tag", "probability" ], "properties": { "total": { "properties": { "amount": { "description": "Class RevenueStore", "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "date": { "type": "string", "example": "2022-05-30" }, "tag": { "type": "integer", "example": "123" }, "probability": { "type": "integer", "example": "50" }, "billingId": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "owner": { "properties": { "type": { "type": "string", "enum": [ "user", "person", "officeGroup" ], "example": "user" }, "id": { "type": "integer", "example": "123" } }, "type": "object" }, "percentSplits": { "required": [ "percent", "recipient", "tag" ], "type": "array", "items": { "properties": { "percent": { "type": "integer", "example": "25" }, "amount": { "type": "integer", "example": "25.50" }, "briefId": { "type": "integer", "example": "123" }, "id": { "type": "integer", "example": "123" }, "refNumber": { "type": "string", "example": "ABC-12345" }, "tag": { "type": "integer", "example": "123" }, "recipient": { "properties": { "type": { "type": "string", "example": "candidate" }, "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "Joe Bloggs" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "api.v4.owner.request.delete": { "title": "Deleting an owner Request Body", "required": [ "ownerId", "ownerType" ], "properties": { "ownerId": { "description": "Associate Owner Store Request", "type": "integer", "example": 1234 }, "ownerType": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" } }, "type": "object" }, "api.v4.meeting.default": { "title": "Meeting Request Body", "required": [ "title", "timezone", "date", "end", "tag", "tags", "private", "sensitivity", "allDay", "includeDetails", "includeName" ], "properties": { "title": { "description": "The subject of the meeting", "type": "string", "example": "Q3 Target Review" }, "assignees": { "description": "An array of attendee person ids", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.assignees" } }, "note": { "description": "A simple note for the meeting", "type": "string", "example": "John will attend!", "nullable": true }, "timezone": { "description": "Set a timezone", "type": "string", "example": "Europe/London" }, "date": { "description": "Set a start date and time for the meeting", "type": "string", "example": "2023-07-20 13:00:00" }, "end": { "description": "Set an end date and time for the meeting", "type": "string", "example": "2023-07-20 14:00:00" }, "address": { "description": "Set a location for the meeting", "type": "string", "example": "London Office" }, "agenda": { "description": "Set an agenda for the meeting", "type": "string", "example": "We will discuss progress during Q3" }, "tag": { "description": "The ID of the status tag. This field is required without tags", "type": "integer", "example": "1234" }, "tags": { "description": "The IDs of the status tags. This field is required without tag", "type": "array", "items": { "type": "integer", "example": 1234 } }, "private": { "description": "Make private in Ezekia", "type": "boolean", "example": true }, "sensitivity": { "description": "Make private in Outlook", "type": "boolean", "example": true }, "allDay": { "description": "Is this meeting all day?", "type": "boolean", "example": true }, "details": { "description": "Add additional details about the meeting", "type": "string", "example": "We will review Q3 and discuss Q4", "nullable": true }, "includeDetails": { "description": "Include additional details in the email", "type": "boolean", "example": true }, "includeName": { "description": "Include person name in the email", "type": "boolean", "example": true }, "sendInvite": { "description": "Send an invite to the attendees. By default, this is set to true. To disable it, set it to false.", "type": "boolean", "example": false }, "microsoftGraphIntegrationId": { "description": "Add the Microsoft Graph integration ID (if applicable)", "type": "integer", "example": "2", "nullable": true }, "context": { "description": "Add the type and id to associate the message with", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.context" }, "nullable": true } }, "type": "object" }, "api.v4.meeting.context": { "title": "Meeting Context Request Body", "description": "The data type name which the meeting belongs to", "properties": { "id": { "description": "The data type id which the meeting belongs to", "type": "integer", "example": "1234" }, "label": { "type": "string", "example": "assignment" } }, "type": "object", "enum": [ "assignment", "opportunity", "person", "company" ] }, "api.v4.meeting.assignees": { "title": "Meeting Assignees Request Body", "properties": { "id": { "type": "integer", "example": 1234, "nullable": true }, "type": { "type": "string", "enum": [ "candidate", "person" ], "example": "candidate", "nullable": true }, "fullname": { "type": "string", "example": "Jane Doe", "nullable": true }, "email": { "type": "string", "example": "me@example.com" } }, "type": "object" }, "api.v4.meeting.updatePinned": { "title": "Meeting Update Pinned", "required": [ "pinned" ], "properties": { "pinned": { "description": "Set whether the meeting should be pinned or not", "type": "boolean", "example": true } }, "type": "object" }, "api.v4.task.storeRequest": { "title": "Task Store", "allOf": [ { "$ref": "#/components/schemas/api.v4.task.default" }, { "properties": { "priority": { "description": "Set a priority for the task", "type": "integer", "example": 1 } }, "type": "object" } ] }, "api.v4.task.update": { "title": "Task Update", "allOf": [ { "$ref": "#/components/schemas/api.v4.task.default" } ] }, "api.v4.task.updateDone": { "title": "Task Update Done", "required": [ "done" ], "properties": { "done": { "description": "Set whether the task has been completed or not", "type": "boolean", "example": true } }, "type": "object" }, "api.v4.task.updatePriority": { "title": "Task Update Priority", "required": [ "priority" ], "properties": { "priority": { "description": "Set the the priority level of the task (4 no priority, 3 low, 2 medium, 1 high)", "type": "integer", "example": 4 } }, "type": "object", "enum": [ 1, 2, 3, 4 ] }, "api.v4.task.updatePinned": { "title": "Task Update Pinned", "required": [ "pinned" ], "properties": { "pinned": { "description": "Set whether the task should be pinned or not", "type": "boolean", "example": true } }, "type": "object" }, "api.v4.task.default": { "title": "Task Request Body", "required": [ "title", "owners", "timezone", "date", "private", "tag", "tags" ], "properties": { "title": { "description": "The title of the task", "type": "string", "example": "Arrange meeting for Thursday" }, "assignees": { "description": "An array of assigned person ids", "type": "array", "items": { "type": "integer", "example": 4321 } }, "note": { "description": "A simple note for the task", "type": "string", "example": "John will attend!" }, "timezone": { "description": "Set a timezone for the due date", "type": "string", "example": "Europe/London" }, "date": { "description": "Set a due date for the task", "type": "string", "example": "2023-07-20 13:00:00" }, "tag": { "description": "The ID of the status tag. This field is required without tags", "type": "integer", "example": 1234 }, "tags": { "description": "The IDs of the status tags. This field is required without tag", "type": "array", "items": { "type": "integer", "example": 1234 } }, "private": { "description": "Is the task private?", "type": "boolean" }, "recursion": { "oneOf": [ { "$ref": "#/components/schemas/api.task.recursion" } ], "nullable": true, "description": "Add recurring details", "type": "object" }, "context": { "description": "Add the type and id to associate the task with", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.context" }, "nullable": true } }, "type": "object" }, "api.v4.task.context": { "title": "Task Context Request Body", "description": "The data type name which the task belongs to", "properties": { "id": { "description": "The data type id which the task belongs to", "type": "integer", "example": "1234" }, "label": { "type": "string", "example": "assignment" } }, "type": "object", "enum": [ "assignment", "opportunity", "person", "company" ] }, "api.v4.owner.request.store": { "title": "Adding an owner Request Body", "required": [ "ownerId", "ownerType" ], "properties": { "ownerId": { "description": "Associate Owner Store Request", "type": "integer", "example": 1234 }, "ownerType": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" } }, "type": "object" }, "api.v4.people.owner.request.store": { "title": "Adding an owner Request Body", "required": [ "ownerId", "ownerType" ], "properties": { "ownerId": { "type": "integer", "example": 1234 }, "ownerType": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" } }, "type": "object" }, "api.v4.ownerTag.request.store": { "title": "Adding an owner Request Body", "required": [ "tagId", "ownerId", "ownerType" ], "properties": { "tagId": { "description": "Associate Owner Store Request", "type": "integer", "example": 1234 }, "ownerId": { "type": "integer", "example": 1234 }, "ownerType": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" } }, "type": "object" }, "api.v4.people.ownerTag.request.store": { "title": "Adding an owner Request Body", "required": [ "tagId", "ownerId", "ownerType" ], "properties": { "tagId": { "type": "integer", "example": 1234 }, "ownerId": { "type": "integer", "example": 1234 }, "ownerType": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" } }, "type": "object" }, "api.v4.person.storeRequest.project": { "title": "People store projects", "properties": { "projectId": { "type": "integer", "example": 1234 }, "projectName": { "type": "string", "example": "Project name" }, "projectType": { "type": "string", "enum": [ "assignment", "opportunity", "list" ], "example": "assignment" } }, "type": "object" }, "api.v4.project.action.update": { "title": "Project Action Update Request Body", "required": [ "actions" ], "properties": { "actions": { "description": "An array of person IDs that will have the specified tags added.", "type": "array", "items": { "properties": { "id": { "description": "Class Update Request", "type": "integer", "example": 1234 }, "tag": { "description": "The ID of the status tag. This field is required without tags", "type": "integer", "example": "1234" }, "tags": { "description": "The IDs of the status tags. This field is required without tag", "type": "array", "items": { "type": "integer", "example": 1234 } }, "days": { "type": "integer", "example": 22 }, "taskName": { "type": "string", "example": "The name of the task in the pipeline" }, "repeating": { "type": "boolean" }, "emailAlert": { "type": "boolean" }, "assignee": { "type": "integer", "example": 1234 } }, "type": "object" } } }, "type": "object" }, "api.person.linkRequest": { "title": "Person Link Request Body", "required": [ "type", "title", "url" ], "properties": { "type": { "$ref": "#/components/schemas/api.person.link.type" }, "title": { "description": "The website title", "type": "string", "example": "Website" }, "url": { "description": "The website URL", "type": "string", "example": "https://www.example.com" } }, "type": "object" }, "api.client.linkRequest": { "title": "Company Link Request Body", "required": [ "type", "url" ], "properties": { "type": { "$ref": "#/components/schemas/api.client.link.type" }, "title": { "description": "The website title", "type": "string", "example": "Website" }, "url": { "description": "The website URL", "type": "string", "example": "https://www.example.com" } }, "type": "object" }, "api.v4.primary-owner.request.store": { "title": "Adding a primary owner Request Body", "required": [ "ownerId" ], "properties": { "ownerId": { "description": "Primary Owner Store Request", "type": "integer", "example": 1234 } }, "type": "object" }, "api.v4.owners.request.index": { "title": "Adding an owner Request Body", "required": [ "ownerType" ], "properties": { "tag": { "description": "Associate Owner Index Request", "type": "integer", "example": 1234 } }, "type": "object" }, "api.relationships.storeDelete": { "title": "Project Store Delete Request Body", "required": [ "parentId", "parentType", "relatedId", "relatedType" ], "properties": { "parentId": { "description": "The ID of the parent type", "type": "integer", "example": "1234" }, "parentType": { "description": "The parent type", "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ], "example": "person" }, "relatedId": { "description": "The ID of the related type", "type": "integer", "example": "1234" }, "relatedType": { "description": "The related type", "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ], "example": "person" }, "projectId": { "description": "The ID of the project (if applicable)", "type": "integer", "example": "1234" } }, "type": "object" }, "api.relationships.update": { "title": "Project Update Request Body", "required": [ "parentId", "parentType", "relatedId", "relatedType" ], "properties": { "parentId": { "description": "The ID of the parent type", "type": "integer", "example": "1234" }, "parentType": { "description": "The parent type", "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ], "example": "person" }, "relatedId": { "description": "The ID of the related type", "type": "integer", "example": "1234" }, "relatedType": { "description": "The related type", "type": "string", "enum": [ "person", "company", "assignment", "opportunity", "list" ], "example": "person" }, "relationId": { "description": "The relationship label ID. How are the two entities related?", "type": "integer", "example": "1234" }, "note": { "description": "A brief note", "type": "string", "example": "This is a note" } }, "type": "object" }, "api.list.pipelineTask": { "title": "List Pipeline", "properties": { "id": { "description": "Class SearchFirmListPipelineResource", "type": "integer", "example": 1234 }, "days": { "description": "Number of days before the task needs to be repeated", "type": "integer", "example": 22 }, "repeating": { "type": "boolean" }, "emailAlert": { "description": "Alert assignees of the task when it is completed/deleted", "type": "boolean" }, "taskName": { "type": "string", "example": "The name of the task in the pipeline" }, "color": { "type": "string", "example": "#12ab12" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "assignee": { "$ref": "#/components/schemas/api.researcher" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.list": { "title": "List", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.list.meta" }, "manager": { "$ref": "#/components/schemas/api.list.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "list" }, "name": { "type": "string", "example": "Potential Clients" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "consultants": { "type": "object" }, "relationships": { "$ref": "#/components/schemas/api.list.relationships" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } }, "officeGroups": { "$ref": "#/components/schemas/api.list.officeGroup" }, "regions": { "$ref": "#/components/schemas/api.list.region" }, "pipeline": { "$ref": "#/components/schemas/api.list.pipelineTask" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "health": { "type": "integer", "example": 23 }, "bucketStats": { "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.stats.tag" } }, "onTarget": { "description": "The number of people that are on target", "type": "integer", "example": 4 }, "overdue": { "description": "The number of people that are overdue", "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } ] }, "api.list.field": { "title": "List Fields", "type": "string", "enum": [ "consultants.users", "consultants.officeGroups", "consultants.regions", "manager.researchNotes", "manager.systemNotes", "manager.documents", "relationships.people" ] }, "api.list.manager": { "title": "List Manager Items", "properties": { "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } } }, "type": "object" }, "api.list.relationships": { "title": "Lists Relationships", "properties": { "people": { "$ref": "#/components/schemas/api.person.default" } }, "type": "object" }, "api.list.meta": { "title": "List Meta Items", "properties": { "watching": { "type": "boolean" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "archived": { "type": "boolean" } }, "type": "object" }, "api.person.aspiration": { "title": "Aspiration", "properties": { "summary": { "description": "Class CandidateAspiration", "type": "string", "example": "Aspiration Summary" }, "careers": { "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/api.location" } }, "permanent": { "$ref": "#/components/schemas/api.person.aspiration.permanent" }, "interim": { "$ref": "#/components/schemas/api.person.aspiration.interim" }, "ned": { "$ref": "#/components/schemas/api.person.aspiration.ned" }, "positionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/api.positionType" } }, "companyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/api.companyType" } } }, "type": "object" }, "api.person.aspiration.interim": { "title": "Aspiration Interim", "properties": { "rate": { "description": "Salary rate", "properties": { "amount": { "description": "Class CandidateAspirationInterim", "type": "integer", "example": "10000" }, "currency": { "type": "string", "example": "USD" } }, "type": "object" } }, "type": "object" }, "api.person.aspiration.ned": { "title": "Aspiration NED", "properties": { "rate": { "description": "Salary rate", "properties": { "amount": { "description": "Class CandidateAspirationNed", "type": "integer", "example": "10000" }, "currency": { "type": "string", "example": "USD" } }, "type": "object" }, "probono": { "type": "boolean" }, "equity": { "type": "boolean" }, "classifications": { "type": "array", "items": { "$ref": "#/components/schemas/api.classification" } } }, "type": "object" }, "api.person.aspiration.permanent": { "title": "Aspiration Permanent", "properties": { "base": { "description": "Salary base", "properties": { "amount": { "description": "Class CandidateAspirationPermanent", "type": "integer", "example": "10000" }, "currency": { "type": "string", "example": "USD" } }, "type": "object" }, "bonus": { "type": "integer", "example": 20 }, "equity": { "type": "boolean" } }, "type": "object" }, "api.person.confidential": { "title": "Confidential Information", "properties": { "currency": { "$ref": "#/components/schemas/api.currency" }, "notice": { "description": "The number of months or hours that a user needs to give as notice leaving their current job. If the number is over 24 then it refers to hours otherwise it refers to months.", "type": "integer", "enum": [ 0, 336, 1, 2, 3, 6, 12, 24 ], "example": "3" }, "bonus": { "description": "The bonus percentage the person receives", "type": "integer", "example": 125 }, "probono": { "description": "True if the person is working pro bono, false otherwise", "type": "boolean", "example": true }, "additionalInfo": { "description": "Additional information", "type": "string", "example": "Open to giving more information" } }, "type": "object", "anyOf": [ { "$ref": "#/components/schemas/api.person.confidential.permanent" }, { "$ref": "#/components/schemas/api.person.confidential.ned" }, { "$ref": "#/components/schemas/api.person.confidential.interim" } ] }, "api.person.confidential.permanent": { "title": "Confidential Information For Permanent Positions", "properties": { "baseSalary": { "$ref": "#/components/schemas/api.currencyAmount" }, "bonus": { "type": "integer", "example": "80" } }, "type": "object" }, "api.person.confidential.ned": { "title": "Confidential Information For NED Positions", "properties": { "nedRate": { "$ref": "#/components/schemas/api.currencyAmount" }, "probono": { "type": "boolean" } }, "type": "object" }, "api.person.confidential.interim": { "title": "Confidential Information For Interim Positions", "properties": { "interimRate": { "$ref": "#/components/schemas/api.currencyAmount" } }, "type": "object" }, "api.person.currentStatus": { "title": "Current Status", "properties": { "industry": { "$ref": "#/components/schemas/api.industry" }, "career": { "$ref": "#/components/schemas/api.career" }, "classification": { "$ref": "#/components/schemas/api.classification" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "location": { "$ref": "#/components/schemas/api.location" }, "": { "properties": { "value": { "$ref": "#/components/schemas/api.aspiration.status.value" }, "name": { "$ref": "#/components/schemas/api.aspiration.status.text" } }, "type": "object" } }, "type": "object" }, "api.person.document": { "title": "Person Document", "properties": { "id": { "description": "Class CandidateDocument", "type": "integer", "example": 1234 }, "filename": { "type": "string", "example": "Document.pdf" }, "extension": { "type": "string", "example": "pdf" }, "primary": { "type": "boolean" } }, "type": "object" }, "api.person.education": { "title": "Person Education", "properties": { "id": { "description": "Class CandidateEducation", "type": "integer", "example": 1234 }, "school": { "type": "string", "example": "Oxford University" }, "degree": { "type": "string", "example": "First Class Honours" }, "field": { "type": "string", "example": "French Literature" }, "startDate": { "type": "integer", "example": 2011 }, "endDate": { "type": "integer", "example": 2018 }, "summary": { "type": "string", "example": "Education Summary" }, "primary": { "type": "boolean" }, "person": { "$ref": "#/components/schemas/api.person.basic" } }, "type": "object" }, "api.person.language": { "title": "Person Language", "properties": { "id": { "description": "Class CandidateLanguage", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "French" }, "code": { "type": "string", "example": "fr" }, "fluency": { "description": "Indicates proficiency in the language: 1 = Native, 2 = Fluent, 3 = Conversational, 4 = Basic", "type": "integer", "example": 1 } }, "type": "object" }, "api.person.basic": { "title": "Person Object", "properties": { "id": { "description": "Class CandidatePosition", "type": "integer", "example": 1234 }, "firstname": { "type": "string", "example": "Jane" }, "lastname": { "type": "string", "example": "Doe" }, "fullname": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "api.person.position": { "title": "Person Position", "properties": { "id": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Director of Communication" }, "career": { "$ref": "#/components/schemas/api.career" }, "classification": { "$ref": "#/components/schemas/api.classification" }, "company": { "description": "The company that the person works for. If they are not linked to an existing record this object will just contain the `name` of the company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "address": { "$ref": "#/components/schemas/api.address" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "location": { "$ref": "#/components/schemas/api.location" }, "teamSize": { "$ref": "#/components/schemas/api.teamSize" }, "teamSizeId": { "$ref": "#/components/schemas/api.teamSizeId" }, "industry": { "$ref": "#/components/schemas/api.industry" }, "department": { "type": "string", "example": "Finance" }, "companyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/api.companyType" } }, "startDate": { "type": "string", "example": "2011-08-14" }, "endDate": { "type": "string", "example": "2018-03-25" }, "skills": { "type": "array", "items": { "type": "string", "example": "Good at managing finances." } }, "achievements": { "type": "array", "items": { "type": "string", "example": "Managed all the finances." } }, "summary": { "type": "string", "example": "Summary of the position" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "primary": { "type": "boolean" }, "tense": { "description": "`true` if the position is current", "type": "boolean" }, "startMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `startDate` field", "type": "boolean" }, "endMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `endDate` field", "type": "boolean" }, "updatedAt": { "description": "updated date returned person last updated", "type": "string" }, "person": { "$ref": "#/components/schemas/api.person.basic" } }, "type": "object" }, "api.company": { "title": "Company", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.company.meta" }, "manager": { "$ref": "#/components/schemas/api.company.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "company" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "consultants": { "type": "object" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } }, "officeGroups": { "$ref": "#/components/schemas/api.list.officeGroup" }, "regions": { "$ref": "#/components/schemas/api.list.region" }, "label": { "type": "string", "example": "company" }, "division": { "type": "string", "example": "The division or subsidiary of the company" }, "description": { "type": "string", "example": "The description of the company" }, "speciality": { "type": "string", "example": "The specialities of the company" }, "size": { "type": "string", "example": "The size of the company" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "address": { "$ref": "#/components/schemas/api.address" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "relationships": { "properties": { "contacts": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "projects": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Chief Technology Officer - London" } }, "type": "object" }, "opportunities": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "New Opportunity" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" } ] }, "api.company.manager": { "title": "Company Manager Items", "properties": { "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "status": { "$ref": "#/components/schemas/api.status.simple" } }, "type": "object" }, "api.company.meta": { "title": "Company Meta Items", "properties": { "archived": { "type": "boolean" }, "boardexId": { "type": "integer", "example": 1234 }, "order": { "type": "integer", "example": 3 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "watching": { "description": "Shows if the authenticated user is watching this company", "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/api.company.meta.permission" } }, "type": "object" }, "api.company.meta.permission": { "title": "Company Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.company.countableFields": { "title": "Company Counts", "type": "string", "enum": [ "links", "manager.researchNotes", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.documents", "manager.customValues", "manager.articles", "relationships.contacts", "relationships.opportunities", "relationships.projects" ] }, "api.company.field": { "title": "Company Fields", "type": "string", "enum": [ "consultants.users", "consultants.office_groups", "consultants.regions", "manager.pendingTasks", "manager.upcomingTask", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.researchNotes", "manager.systemNotes", "manager.documents", "manager.customValues", "manager.status", "relationships.contacts", "relationships.projects", "relationships.opportunities" ] }, "api.address": { "title": "Address", "properties": { "id": { "description": "Class CandidateLink", "type": "integer", "example": 1234 }, "full": { "type": "string", "example": "123 The Street" }, "line1": { "type": "string", "example": "Flat 2B" }, "line2": { "type": "string", "example": "123 Catton Court" }, "line3": { "type": "string", "example": "Oak Ridge" }, "line4": { "type": "string", "example": "Somewhere" }, "city": { "type": "string", "example": "Birmingham" }, "state": { "type": "string", "example": "Essex" }, "country": { "type": "string", "example": "Ireland" }, "postcode": { "type": "string", "example": "CT12 8GR" }, "label": { "type": "string", "enum": [ "private", "business", "other", "invoice" ], "example": "private" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.email": { "title": "Email", "properties": { "id": { "description": "Class CandidateLink", "type": "integer", "example": 1234 }, "address": { "type": "string", "example": "me@example.com" }, "label": { "type": "string", "enum": [ "private", "work", "other", "predicted" ], "example": "private" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" }, "updatedAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" } }, "type": "object" }, "api.link": { "title": "Link", "properties": { "id": { "description": "Class CandidateLink", "type": "integer", "example": 1234 }, "url": { "type": "string", "example": "https://example.com" }, "title": { "type": "string", "example": "Example Site" }, "type": { "type": "string", "enum": [ "website", "linkedin", "xing" ], "example": "linkedin" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.phone": { "title": "Phone", "properties": { "id": { "description": "Class CandidateLink", "type": "integer", "example": 1234 }, "number": { "type": "string", "example": "+123 456 789" }, "label": { "type": "string", "enum": [ "assistant", "billing", "direct", "home", "manager", "mobile", "other", "private", "switchboard", "work" ], "example": "work" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" }, "updatedAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" } }, "type": "object" }, "api.customValue": { "title": "Custom Value", "properties": { "id": { "description": "Class CustomValueResource", "type": "integer", "example": 1234 }, "value": { "$ref": "#/components/schemas/api.customField.value" }, "field": { "$ref": "#/components/schemas/api.searchFirmCustomField" } }, "type": "object" }, "api.searchFirmCustomField": { "title": "Custom Field", "properties": { "id": { "description": "Class SearchFirmCustomFieldResource", "type": "integer", "example": 1234 }, "sectionName": { "type": "string", "example": "details" }, "label": { "type": "string", "example": "Birthday" }, "labelType": { "type": "string", "example": "rating" }, "labelData": { "type": "string", "format": "json", "example": "{\"max\": 5}" }, "count": { "type": "integer", "example": 3 }, "hashId": { "type": "string", "example": "ejRe" }, "order": { "type": "integer", "example": 3 } }, "type": "object" }, "api.document": { "title": "Document", "properties": { "id": { "description": "Class Document", "type": "integer", "example": 1234 }, "filename": { "type": "string", "example": "Document.pdf" }, "extension": { "type": "string", "example": "pdf" }, "user": { "$ref": "#/components/schemas/api.researcher" }, "shouldAttach": { "type": "boolean" }, "personId": { "type": "integer", "example": 1234 }, "executiveId": { "type": "integer", "example": 1234 }, "addedBy": { "type": "string", "example": "Jane Doe" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v1.assignmentInfo": { "title": "Assignment Info", "properties": { "id": { "description": "Class AssignmentInfoResource", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.person.default": { "title": "Person Default", "properties": { "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "person" }, "label": { "type": "string", "example": "person" }, "name": { "type": "string", "example": "Jane Doe" }, "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "summary": { "type": "string", "example": "Jane Doe has previously worked for ..." }, "profilePicture": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/api.email" } }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/api.phone" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "profile": { "description": "The person profile", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.person.nal": { "title": "Person NAL", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.person.profile" }, "meta": { "$ref": "#/components/schemas/api.person.meta.nal" }, "counts": { "$ref": "#/components/schemas/api.person.counts.nal" } }, "type": "object" } ] }, "api.person.full": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.person.profile" }, "relationships": { "$ref": "#/components/schemas/api.person.relationships" }, "manager": { "$ref": "#/components/schemas/api.person.manager" }, "meta": { "$ref": "#/components/schemas/api.person.meta" }, "counts": { "$ref": "#/components/schemas/api.person.counts" } }, "type": "object" } ] }, "api.person": { "title": "Person", "anyOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "$ref": "#/components/schemas/api.person.full" } ] }, "api.person.countableFields": { "title": "Person Counts", "type": "string", "enum": [ "emails", "addresses", "phones", "links", "profile.positions", "profile.education", "profile.documents", "profile.languages", "relationships.lists", "relationships.opportunities", "relationships.assignments", "relationships.candidatesLists", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.person.field": { "title": "Person Fields", "type": "string", "enum": [ "profile.aspirations", "profile.confidential", "profile.currentStatus", "profile.positions", "profile.education", "profile.documents", "profile.languages", "profile.headline", "relationships.lists", "relationships.opportunities", "relationships.assignments", "relationships.candidatesLists", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.mostRecentResearcherNote", "manager.mostRecentLinkedNote", "manager.attachments", "manager.customValues" ] }, "api.person.candidate": { "title": "Person Fields", "type": "string", "enum": [ "meta.candidate" ] }, "api.person.fieldWithCandidate": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.person.field" }, { "$ref": "#/components/schemas/api.person.candidate" } ] }, "api.person.profile": { "title": "Person Profile", "properties": { "aspirations": { "$ref": "#/components/schemas/api.person.aspiration" }, "currentStatus": { "$ref": "#/components/schemas/api.person.currentStatus" }, "confidential": { "$ref": "#/components/schemas/api.person.confidential" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.language" } }, "headline": { "type": "string", "example": "Candidate Headline" } }, "type": "object" }, "api.person.relationships": { "title": "Person Relationships", "properties": { "lists": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.list" } }, "billings": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.billing" } }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.project" } }, "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.project" } }, "candidatesLists": { "type": "array", "items": { "$ref": "#/components/schemas/api.v1.assignmentInfo" } } }, "type": "object" }, "api.person.list": { "title": "Person Bucket Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Potential Clients" }, "health": { "type": "integer", "example": 55 }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.person.billing": { "title": "Person Billing Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.person.project": { "title": "Person Project Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.person.manager": { "title": "Person Manager Items", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "attendeeMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "mostRecentResearcherNote": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "mostRecentLinkedNote": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } } }, "type": "object" }, "api.person.meta": { "title": "Person Meta Info", "properties": { "watching": { "description": "Shows if the authenticated user is watching this person", "type": "boolean" }, "sameCandidateOnAssignments": { "description": "Shows if the person exists on an assignment", "type": "boolean" }, "completion": { "$ref": "#/components/schemas/api.person.meta.completion" }, "permissions": { "$ref": "#/components/schemas/api.person.meta.permission" }, "archived": { "type": "boolean" }, "offLimitAgreements": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } } }, "type": "object" }, "api.person.meta.candidate": { "title": "Person Meta Info In Assignment Context", "allOf": [ { "$ref": "#/components/schemas/api.person.meta" }, { "properties": { "candidate": { "$ref": "#/components/schemas/api.person.meta.candidateInfo" } }, "type": "object" } ] }, "api.person.meta.completion": { "title": "Person Completion Info", "description": "Information on how complete the profile information is", "properties": { "id": { "type": "integer", "example": 1234 }, "score": { "description": "A percentage score indicating how complete the profile is", "type": "integer" }, "ignored": { "description": "Indicates if the incomplete status should be ignored", "type": "boolean" } }, "type": "object" }, "api.person.meta.candidateInfo": { "title": "Person Candidate Info", "description": "Information of the person in the context of an assignment.", "properties": { "rank": { "description": "Where the person has been manually ranked in the assignment", "type": "integer", "example": 1 }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "addedBy": { "type": "string", "example": "Jane Doe" }, "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" }, "api.person.meta.permission": { "title": "Person Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.person.meta.nal": { "title": "Person Meta Info", "properties": { "connected": { "description": "Whether or not the person is connected to the authenticated firm.", "type": "boolean" }, "lastLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "firmLink": { "description": "The ID of the copy owned by the firm if exists.", "type": "integer", "example": 1234 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" }, "api.person.counts.nal": { "title": "Person Counts NAL", "properties": { "profile": { "properties": { "positions": { "type": "integer" }, "education": { "type": "integer" } }, "type": "object" }, "emails": { "type": "integer" }, "phones": { "type": "integer" }, "addresses": { "type": "integer" }, "links": { "type": "integer" } }, "type": "object" }, "api.person.counts": { "title": "Person Counts", "allOf": [ { "$ref": "#/components/schemas/api.person.counts.nal" }, { "properties": { "researchNotes": { "type": "integer" }, "systemNotes": { "type": "integer" }, "gdprNotes": { "type": "integer" }, "tasks": { "type": "integer" }, "pendingTasks": { "type": "integer" }, "doneTasks": { "type": "integer" }, "meetings": { "type": "integer" }, "upcomingMeetings": { "type": "integer" }, "pastMeetings": { "type": "integer" }, "attachments": { "type": "integer" }, "customValues": { "type": "integer" }, "tags": { "type": "integer" }, "emails": { "type": "integer" }, "forms": { "type": "integer" } }, "type": "object" }, { "properties": { "companies": { "type": "integer" }, "lists": { "type": "integer" }, "custom": { "type": "integer" }, "billings": { "type": "integer" }, "assignments": { "type": "integer" }, "opportunities": { "type": "integer" }, "candidatesLists": { "type": "integer" } }, "type": "object" } ] }, "api.importEmailResource": { "title": "Import Email Object", "properties": { "id": { "type": "integer", "example": "1234" }, "searchFirmId": { "type": "integer", "example": "584" }, "from": { "type": "string", "example": "person@example.com" }, "to": { "type": "string", "example": "person1@example.com, person2@example.com" }, "cc": { "type": "string", "example": "person1@example.com, person2@example.com" }, "bcc": { "type": "string", "example": "person1@example.com, person2@example.com" }, "subject": { "type": "string", "example": "Meeting 12pm tommorrow" }, "text": { "type": "string", "example": "Dear John, Would you like ..." }, "html": { "type": "string", "example": "

Dear John, Would you like ...

" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "relationships": { "$ref": "#/components/schemas/api.importEmailResource.relationships" }, "manager": { "$ref": "#/components/schemas/api.importEmailResource.manager" } }, "type": "object" }, "api.importEmailResource.relationships": { "title": "Import Email Relationships", "properties": { "people": { "description": "An array of people belonging to the imported email.", "type": "array", "items": { "$ref": "#/components/schemas/api.person.basic" } } }, "type": "object" }, "api.importEmailResource.manager": { "title": "Import Email Manager", "properties": { "attachments": { "description": "An array of attachments belonging to the imported email.", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234 }, "filename": { "type": "string", "example": "Document.pdf" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" } } }, "type": "object" }, "api.meeting": { "title": "Meeting Object", "properties": { "id": { "description": "The meeting ID", "type": "integer", "example": 1234 }, "userId": { "description": "The user's ID", "type": "integer", "example": 1234 }, "title": { "description": "The meeting title", "type": "string", "example": "Meeting Title" }, "assignees": { "description": "The meeting invitees", "type": "array", "items": { "$ref": "#/components/schemas/api.assignee" } }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "private": { "description": "Is the meeting private?", "type": "boolean", "example": true }, "sensitivity": { "description": "Is the meeting sensitive?", "type": "boolean", "example": true }, "allDay": { "description": "Is it an all day meeting?", "type": "boolean", "example": true }, "organizer": { "description": "The organizer's name and email", "type": "string", "example": "Jane Doe " }, "isOrganizer": { "type": "boolean", "example": true }, "pinned": { "description": "Is the meeting pinned?", "type": "boolean", "example": true }, "sendInvite": { "type": "boolean", "example": true }, "note": { "description": "The meeting note", "type": "string", "example": "Meeting Note" }, "timezone": { "description": "The meeting timezone", "type": "string", "example": "Europe/London" }, "date": { "description": "The meeting start date/time", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end": { "description": "The meeting end date/time", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "address": { "description": "The address of the meeting", "type": "string", "example": "123 The Street" }, "agenda": { "description": "The meeting agenda", "type": "string", "example": "What are we doing?" }, "details": { "description": "The meeting details", "type": "string", "example": "Here's how it went." }, "includeDetails": { "description": "Include additional details in the email", "type": "boolean" }, "includeName": { "description": "Include person name in the email", "type": "boolean" }, "documents": { "description": "An array of documents to attach to the meeting", "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "channels": { "description": "An array of channels that belong to the meeting", "type": "array", "items": { "$ref": "#/components/schemas/api.calendarable" } }, "teamsMeeting": { "description": "Is this a Teams meeting?", "type": "boolean" }, "teamsUrl": { "description": "The Teams URL", "properties": { "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "string", "example": "https://teams.microsoft.com/l/meetup-join/..." } }, "type": "object" }, "api.meeting.field": { "title": "Meeting Fields", "type": "string", "enum": [ "feedbacks", "documents" ] }, "api.notesCollection": { "title": "Notes Collection", "properties": { "gdprNotes": { "description": "Class NoteCollection", "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "systemNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } } }, "type": "object" }, "api.note": { "title": "Note", "properties": { "id": { "description": "Class NoteResource", "type": "integer", "example": 1234 }, "author": { "type": "string", "example": "Jane Doe" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "text": { "type": "string", "example": "An example note." }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "pinned": { "type": "boolean", "example": "true" }, "groupCode": { "description": "The shared code between notes that were created at once.", "type": "string" }, "subNotes": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "notable": { "$ref": "#/components/schemas/api.notableInfo" }, "context": { "$ref": "#/components/schemas/api.notableInfo" } }, "type": "object" }, "api.offLimits.agreement": { "title": "Off Limit Agreement", "properties": { "id": { "description": "Class OffLimitAgreement", "type": "integer", "example": 1234 }, "agreementName": { "type": "string", "example": "Amazon" }, "agreementType": { "type": "string", "enum": [ "person", "company" ] }, "agreementId": { "type": "integer", "example": 1234 }, "filter": { "type": "string", "example": "Amazon" }, "endDate": { "type": "string", "example": "2031-12-31" }, "description": { "type": "string", "example": "Off Limit Agreement with Amazon" }, "constraint": { "$ref": "#/components/schemas/api.offLimits.agreement.constraint" }, "addedBy": { "type": "string", "example": "Jane Doe" }, "createdAt": { "type": "string", "example": "2018-12-31" } }, "type": "object" }, "api.project.default": { "title": "Project", "properties": { "id": { "description": "Class ProjectResource", "type": "integer", "example": 1234 }, "label": { "type": "string", "example": "assignment" }, "dataType": { "type": "string", "example": "assignment" }, "title": { "type": "string", "example": "Chief Technology Officer - London" }, "projectId": { "type": "string", "example": "project123" }, "description": { "type": "string", "example": "project description" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "careers": { "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "start_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "relationships": { "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" } }, "type": "object" } }, "type": "object" }, "api.project.countableFields": { "title": "Project Counts", "type": "string", "enum": [ "manager.researchNotes", "manager.systemNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom" ] }, "api.project.field": { "title": "Project Fields", "type": "string", "enum": [ "consultants.users", "consultants.officeGroups", "consultants.regions", "industries", "careers", "completion", "compensation", "manager.researchNotes", "manager.systemNotes", "manager.gdprNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendedMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom", "relationships.bucket" ] }, "api.company.simple": { "title": "Simple Company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "color": { "type": "string", "example": "#abcabc" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.project.manager": { "title": "Project Manager Items", "properties": { "status": { "$ref": "#/components/schemas/api.status.simple" }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "attendedMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } } }, "type": "object" }, "api.project.meta": { "title": "Project Meta Items", "properties": { "watching": { "type": "boolean" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "archived": { "type": "boolean" } }, "type": "object" }, "api.meeting.simple": { "title": "Simple Meeting Object", "properties": { "id": { "description": "Class SimpleMeetingResource", "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the thing" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "note": { "type": "string", "example": "Task Note" }, "address": { "type": "string", "example": "123 The Street" }, "agenda": { "type": "string", "example": "What are we doing?" }, "details": { "type": "string", "example": "Here's how it went." }, "private": { "type": "boolean" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "owners": { "type": "array", "items": { "properties": { "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.note.simple": { "title": "Simple Note", "properties": { "id": { "description": "Class SimpleNoteResource", "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "An example note." }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "author": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "api.status.simple": { "title": "Simple Status Object", "properties": { "id": { "description": "Class SimpleStatusTagResource", "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "Identified" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "api.task.simple": { "title": "Simple Task Object", "properties": { "id": { "description": "Class SimpleTaskResource", "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the thing" }, "done": { "type": "boolean" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "note": { "type": "string", "example": "Task Note" }, "private": { "type": "boolean" }, "pipeline": { "description": "Only relevant for tasks on leads", "type": "array", "items": { "$ref": "#/components/schemas/api.task.pipeline" } }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "recursion": { "description": "How the task repeats", "type": "array", "items": { "$ref": "#/components/schemas/api.task.recursion" } }, "owners": { "type": "array", "items": { "properties": { "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.task": { "title": "Task Object", "properties": { "id": { "description": "Class TaskResource", "type": "integer", "example": 1234 }, "userId": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the task" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "note": { "type": "string", "example": "Task Note" }, "timezone": { "type": "string", "example": "Europe/London" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "done": { "type": "boolean", "example": true }, "priority": { "type": "integer", "example": 2 }, "private": { "type": "boolean", "example": true }, "pinned": { "type": "boolean", "example": true }, "lastPinned": { "type": "boolean", "example": true }, "recursion": { "description": "How the task repeats", "type": "array", "items": { "$ref": "#/components/schemas/api.task.recursion" } }, "pipeline": { "description": "Only relevant for tasks on leads", "type": "array", "items": { "$ref": "#/components/schemas/api.task.pipeline" } }, "channels": { "description": "An array of channels that belong to the task", "type": "array", "items": { "$ref": "#/components/schemas/api.calendarable" } }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "api.task.field": { "title": "Task Fields", "type": "string", "enum": [ "feedbacks", "pipeline" ] }, "api.task.pipeline": { "title": "Task Pipeline", "properties": { "id": { "type": "integer", "example": 1234 }, "bucket": { "type": "integer", "example": 1234 } }, "type": "object" }, "api.list.officeGroup": { "title": "Office Group", "properties": { "id": { "description": "Class OfficeGroupResource", "type": "integer", "example": 1234 }, "search_firm_id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "An Office Group" }, "description": { "type": "string", "example": "A description" }, "user_ids": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" }, "api.assignee": { "title": "Assignee", "properties": { "id": { "description": "Class SearchUserResource", "type": "integer", "example": 1234 }, "type": { "type": "string", "example": "person" }, "fullname": { "type": "string", "example": "Jane Doe" }, "email": { "type": "string", "example": "me@example.com" } }, "type": "object" }, "api.calendarable": { "title": "Calendarable Object", "properties": { "id": { "description": "Class CalendarableResource", "type": "integer", "example": 1234 }, "type": { "type": "string", "example": "assignment" }, "label": { "type": "string", "example": "assignment" }, "name": { "type": "string", "example": "Chief Technology Officer - London" } }, "type": "object" }, "api.graph": { "title": "Microsoft Graph Object", "properties": { "id": { "description": "The Microsoft Graph ID", "type": "integer", "example": 1234 }, "userId": { "description": "The user's ID", "type": "integer", "example": 1234 }, "email": { "description": "The user's email address", "type": "string", "example": "john.smith@gmail.com" }, "status": { "description": "The connection status. 0 = connected", "type": "integer", "example": 0 }, "primary": { "description": "Is this the primary email address?", "type": "boolean", "example": true }, "is_mcp": { "description": "Is connected to the Outlook MCP?", "type": "boolean", "example": false } }, "type": "object" }, "api.list.region": { "title": "Region", "properties": { "id": { "description": "Class RegionResource", "type": "integer", "example": 1234 }, "search_firm_id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "A Region" }, "description": { "type": "string", "example": "A description" }, "office_groups": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.officeGroup" } }, "user_ids": { "type": "array", "items": { "type": "integer", "example": 1234 } } }, "type": "object" }, "api.billing": { "title": "Billing Object", "properties": { "id": { "type": "integer", "example": 1234 }, "brief_id": { "type": "integer", "example": 1234 }, "client_id": { "type": "integer", "example": 1234 }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.default" } }, "revenues": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.revenue" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.default" } }, "fixedFees": { "type": "array", "items": { "$ref": "#/components/schemas/api.billing.feeSplit" } } }, "type": "object" }, "api.billing.feeSplit": { "title": "Billing Fee Split Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "refNumber": { "type": "string", "example": "ref1234" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "recipient": { "$ref": "#/components/schemas/api.billing.recipient" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "project": { "properties": { "label": { "type": "string", "example": "assignment" }, "id": { "type": "integer", "example": "123" }, "projectId": { "type": "string", "example": "project123" } }, "type": "object" }, "note": { "type": "string", "example": "This is a note" }, "isFixedFee": { "type": "boolean" } }, "type": "object" }, "api.invoiceItem": { "title": "Invoice Item Object", "properties": { "id": { "type": "integer", "example": "1234" }, "description": { "type": "string", "example": "Fee" }, "amount": { "$ref": "#/components/schemas/api.currencyAmount" }, "quantity": { "type": "integer", "example": "1" }, "tag": { "$ref": "#/components/schemas/api.status.simple" } }, "type": "object" }, "api.invoice.default": { "title": "Billing Invoice Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "invoicedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "sentAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "refNumber": { "type": "string", "example": "ref1234" }, "currency": { "$ref": "#/components/schemas/api.currency" }, "total": { "$ref": "#/components/schemas/api.currencyAmount" }, "items": { "$ref": "#/components/schemas/api.invoiceItem" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "template": { "properties": { "id": { "type": "integer", "example": "1234" }, "name": { "type": "string", "example": "Default Template" }, "firmName": { "type": "string", "example": "ACME" }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "address": { "type": "string", "example": "123 Catton Court" }, "website": { "type": "string", "example": "https://example.com" }, "taxPercent": { "type": "number", "format": "float", "example": "20.0" }, "taxType": { "type": "number", "format": "float", "example": "20.0" }, "incremental": { "type": "boolean" }, "numberPattern": { "type": "string", "example": "EZ0001" }, "nextNumber": { "type": "string", "example": "EZ0002" }, "lastNumber": { "type": "string", "example": "EZ0001" }, "paymentTerms": { "type": "integer", "example": "30" }, "footer": { "type": "string", "example": "Invoice footer" }, "addedBy": { "type": "string", "example": "John Smith" }, "note": { "type": "string", "example": "This is a note" }, "title": { "type": "string", "example": "Invoice" }, "altTitle": { "type": "string", "example": "Credit Note" }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "taxType": { "type": "string", "example": "VAT" }, "taxPercent": { "type": "string", "example": "20" }, "filename": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.invoice.relationships" } }, "type": "object" }, "api.invoice.full": { "title": "Invoice Full", "allOf": [ { "properties": { "": { "$ref": "#/components/schemas/api.invoice.default" }, "relationships": { "$ref": "#/components/schemas/api.invoice.relationships" } }, "type": "object" } ] }, "api.invoice.relationships": { "title": "Invoice Relationships", "properties": { "revenue": { "$ref": "#/components/schemas/api.billing.revenue" }, "contact": { "$ref": "#/components/schemas/api.person.default" }, "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.invoice.countableFields": { "title": "Invoice Counts", "type": "string", "enum": [ "relationships.percentSplits" ] }, "api.invoice.field": { "title": "Invoice Fields", "type": "string", "enum": [ "relationships.contact", "relationships.company", "relationships.project", "relationships.percentSplit", "relationships.revenue" ] }, "api.invoiceTemplate": { "title": "Invoice Template Object", "properties": { "id": { "type": "integer", "example": "1234" }, "name": { "type": "string", "example": "Default Template" }, "firmName": { "type": "string", "example": "ACME" }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "address": { "type": "string", "example": "123 Catton Court" }, "website": { "type": "string", "example": "https://example.com" }, "taxPercent": { "type": "number", "format": "float", "example": "20.0" }, "taxType": { "type": "number", "format": "float", "example": "20.0" }, "incremental": { "type": "boolean" }, "numberPattern": { "type": "string", "example": "EZ0001" }, "nextNumber": { "type": "string", "example": "EZ0002" }, "lastNumber": { "type": "string", "example": "EZ0001" }, "paymentTerms": { "type": "integer", "example": "30" }, "footer": { "type": "string", "example": "Invoice footer" }, "addedBy": { "type": "string", "example": "John Smith" }, "note": { "type": "string", "example": "This is a note" }, "title": { "type": "string", "example": "Invoice" }, "altTitle": { "type": "string", "example": "Credit Note" }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "api.billing.recipient": { "title": "Billing Recipient Object", "properties": { "owner": { "$ref": "#/components/schemas/api.researcher" }, "name": { "type": "string", "example": "Joe Bloggs" }, "id": { "type": "integer", "example": "123" }, "type": { "type": "string", "example": "candidate" }, "email": { "type": "string", "example": "joe@example.com" } }, "type": "object" }, "api.billing.recipient.relationships": { "title": "Billing Recipient Relationships", "properties": { "officeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.officeGroup" } } }, "type": "object" }, "api.billing.revenue": { "title": "Billing Revenue Object", "properties": { "id": { "type": "integer", "example": "1234" }, "date": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "amount": { "$ref": "#/components/schemas/api.currencyAmount" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "probability": { "type": "integer", "example": "30" }, "refNumber": { "type": "string" }, "note": { "type": "string" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.revenue.relationships" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.revenue.relationships": { "title": "Revenue Relationships", "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.revenue.field": { "title": "Revenue Fields", "type": "string", "enum": [ "relationships.company", "relationships.project", "relationships.percentSplits" ] }, "api.researcher": { "title": "Researcher", "properties": { "id": { "description": "Class SearchUserResource", "type": "integer", "example": 1234 }, "email": { "type": "string", "example": "me@example.com" }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+123 456 789" }, "location": { "type": "string", "example": "London" }, "profilePicture": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "relationships": { "$ref": "#/components/schemas/api.searchUser.relationships" } }, "type": "object" }, "api.searchUser.relationships": { "title": "Search User Relationships", "properties": { "officeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.officeGroup" } } }, "type": "object" }, "api.status": { "title": "Status Tag", "properties": { "id": { "description": "Class StatusTag", "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "Identified" }, "color": { "type": "string", "example": "#abcabc" }, "default": { "type": "boolean" }, "order": { "type": "integer" }, "type": { "type": "string", "enum": [ "assignment", "candidate", "lead", "opportunity", "client", "task", "meeting", "revenue", "invoice", "note" ] }, "hidden": { "type": "boolean" }, "nalText": { "type": "string", "example": "added" }, "canDelete": { "type": "boolean" }, "taggedCount": { "type": "integer", "example": 53 }, "hashId": { "description": "The string that is used to reference this tag in the Custom Word Reports", "type": "string", "example": "abc123" }, "addedAt": { "type": "string", "example": "2024-09-30T07:18:55.000000Z" } }, "type": "object" }, "api.v2.person.basic": { "title": "Person Object", "properties": { "id": { "description": "Class CandidatePosition", "type": "integer", "example": 1234 }, "firstname": { "type": "string", "example": "Jane" }, "lastname": { "type": "string", "example": "Doe" }, "fullname": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "api.v2.person.position": { "title": "Person Position", "properties": { "id": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Director of Communication" }, "career": { "$ref": "#/components/schemas/api.career" }, "classification": { "$ref": "#/components/schemas/api.classification" }, "company": { "description": "The company that the person works for. If they are not linked to an existing record this object will just contain the `name` of the company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "location": { "$ref": "#/components/schemas/api.location" }, "teamSize": { "$ref": "#/components/schemas/api.teamSize" }, "teamSizeId": { "$ref": "#/components/schemas/api.teamSizeId" }, "industry": { "$ref": "#/components/schemas/api.industry" }, "department": { "type": "string", "example": "Finance" }, "companyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/api.companyType" } }, "startDate": { "type": "string", "example": "2011-08-14" }, "endDate": { "type": "string", "example": "2018-03-25" }, "skills": { "type": "array", "items": { "type": "string", "example": "Good at managing finances." } }, "achievements": { "type": "array", "items": { "type": "string", "example": "Managed all the finances." } }, "summary": { "type": "string", "example": "Summary of the position" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "primary": { "type": "boolean" }, "tense": { "description": "`true` if the position is current", "type": "boolean" }, "startMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `startDate` field", "type": "boolean" }, "endMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `endDate` field", "type": "boolean" }, "updatedAt": { "description": "updated date returned person last updated", "type": "string" } }, "type": "object" }, "api.v2.person.currentStatus": { "title": "Current Status", "properties": { "careers": { "description": "Class CandidateCurrentStatus", "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "classification": { "$ref": "#/components/schemas/api.classification" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/api.location" } }, "status": { "properties": { "value": { "$ref": "#/components/schemas/api.aspiration.status.value" }, "name": { "$ref": "#/components/schemas/api.aspiration.status.text" } }, "type": "object" } }, "type": "object" }, "api.v2.company": { "title": "Company", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.v2.company.meta" }, "manager": { "$ref": "#/components/schemas/api.v2.company.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "company" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "consultants": { "type": "object" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } }, "officeGroups": { "$ref": "#/components/schemas/api.list.officeGroup" }, "regions": { "$ref": "#/components/schemas/api.list.region" }, "label": { "type": "string", "example": "company" }, "division": { "type": "string", "example": "The division or subsidiary of the company" }, "description": { "type": "string", "example": "The description of the company" }, "speciality": { "type": "string", "example": "The specialities of the company" }, "size": { "type": "string", "example": "The size of the company" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "relationships": { "properties": { "contacts": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "projects": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Chief Technology Officer - London" } }, "type": "object" }, "opportunities": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "New Opportunity" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" } ] }, "api.v2.company.manager": { "title": "Company Manager Items", "properties": { "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "status": { "$ref": "#/components/schemas/api.status.simple" } }, "type": "object" }, "api.v2.company.meta": { "title": "Company Meta Items", "properties": { "archived": { "type": "boolean" }, "boardexId": { "type": "integer", "example": 1234 }, "order": { "type": "integer", "example": 3 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "watching": { "description": "Shows if the authenticated user is watching this company", "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/api.v2.company.meta.permission" } }, "type": "object" }, "api.v2.company.meta.permission": { "title": "Company Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v2.company.countableFields": { "title": "Company Counts", "type": "string", "enum": [ "links", "manager.researchNotes", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.documents", "manager.customValues", "manager.articles", "relationships.contacts", "relationships.opportunities", "relationships.projects" ] }, "api.v2.company.field": { "title": "Company Fields", "type": "string", "enum": [ "consultants.users", "consultants.office_groups", "consultants.regions", "manager.pendingTasks", "manager.upcomingTask", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.researchNotes", "manager.systemNotes", "manager.documents", "manager.customValues", "manager.status", "relationships.contacts", "relationships.projects", "relationships.opportunities" ] }, "api.v2.assignmentInfo": { "title": "Assignment Info", "properties": { "id": { "description": "Class AssignmentInfoResource", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v2.person.default": { "title": "Person Default", "properties": { "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "person" }, "label": { "type": "string", "example": "person" }, "name": { "type": "string", "example": "Jane Doe" }, "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "summary": { "type": "string", "example": "Jane Doe has previously worked for ..." }, "profilePicture": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/api.email" } }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/api.phone" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "profile": { "description": "The person profile", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v2.person.nal": { "title": "Person NAL", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.person.profile" }, "meta": { "$ref": "#/components/schemas/api.person.meta.nal" }, "counts": { "$ref": "#/components/schemas/api.person.counts.nal" } }, "type": "object" } ] }, "api.v2.person.full": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.v2.person.profile" }, "relationships": { "$ref": "#/components/schemas/api.person.relationships" }, "manager": { "$ref": "#/components/schemas/api.person.manager" }, "meta": { "$ref": "#/components/schemas/api.person.meta" }, "counts": { "$ref": "#/components/schemas/api.person.counts" } }, "type": "object" } ] }, "api.v2.person": { "title": "Person", "anyOf": [ { "$ref": "#/components/schemas/api.v2.person.default" }, { "$ref": "#/components/schemas/api.v2.person.full" } ] }, "api.v2.person.countableFields": { "title": "Person Counts", "type": "string", "enum": [ "emails", "addresses", "phones", "links", "profile.positions", "profile.education", "profile.documents", "profile.languages", "relationships.lists", "relationships.opportunities", "relationships.assignments", "relationships.candidatesLists", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v2.person.field": { "title": "Person Fields", "type": "string", "enum": [ "profile.aspirations", "profile.confidential", "profile.currentStatus", "profile.positions", "profile.education", "profile.documents", "profile.languages", "profile.headline", "relationships.lists", "relationships.opportunities", "relationships.assignments", "relationships.candidatesLists", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v2.person.candidate": { "title": "Person Fields", "type": "string", "enum": [ "meta.candidate" ] }, "api.v2.person.fieldWithCandidate": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.v2.person.field" }, { "$ref": "#/components/schemas/api.v2.person.candidate" } ] }, "api.v2.person.profile": { "title": "Person Profile", "properties": { "aspirations": { "$ref": "#/components/schemas/api.person.aspiration" }, "currentStatus": { "$ref": "#/components/schemas/api.v2.person.currentStatus" }, "confidential": { "$ref": "#/components/schemas/api.person.confidential" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.language" } }, "headline": { "type": "string", "example": "Candidate Headline" } }, "type": "object" }, "api.v2.person.relationships": { "title": "Person Relationships", "properties": { "lists": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.list" } }, "billings": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.billing" } }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.project" } }, "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.project" } }, "candidatesLists": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.assignmentInfo" } } }, "type": "object" }, "api.v2.person.list": { "title": "Person Bucket Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Potential Clients" }, "health": { "type": "integer", "example": 55 }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v2.person.billing": { "title": "Person Billing Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.v2.person.project": { "title": "Person Project Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.v2.person.manager": { "title": "Person Manager Items", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "attendeeMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } } }, "type": "object" }, "api.v2.person.meta": { "title": "Person Meta Info", "properties": { "watching": { "description": "Shows if the authenticated user is watching this person", "type": "boolean" }, "sameCandidateOnAssignments": { "description": "Shows if the person exists on an assignment", "type": "boolean" }, "completion": { "$ref": "#/components/schemas/api.person.meta.completion" }, "permissions": { "$ref": "#/components/schemas/api.person.meta.permission" }, "archived": { "type": "boolean" }, "offLimitAgreements": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "dueDiligenceFlag": { "$ref": "#/components/schemas/api.v2.dueDiligenceFlag" }, "dueDiligenceChecks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.dueDiligenceCheck" } } }, "type": "object" }, "api.v2.person.meta.candidate": { "title": "Person Meta Info In Assignment Context", "allOf": [ { "$ref": "#/components/schemas/api.person.meta" }, { "properties": { "candidate": { "$ref": "#/components/schemas/api.person.meta.candidateInfo" } }, "type": "object" } ] }, "api.v2.person.meta.completion": { "title": "Person Completion Info", "description": "Information on how complete the profile information is", "properties": { "id": { "type": "integer", "example": 1234 }, "score": { "description": "A percentage score indicating how complete the profile is", "type": "integer" }, "ignored": { "description": "Indicates if the incomplete status should be ignored", "type": "boolean" } }, "type": "object" }, "api.v2.person.meta.candidateInfo": { "title": "Person Candidate Info", "description": "Information of the person in the context of an assignment.", "properties": { "rank": { "description": "Where the person has been manually ranked in the assignment", "type": "integer", "example": 1 }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "addedBy": { "type": "string", "example": "Jane Doe" }, "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" }, "api.v2.person.meta.permission": { "title": "Person Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v2.person.meta.nal": { "title": "Person Meta Info", "properties": { "connected": { "description": "Whether or not the person is connected to the authenticated firm.", "type": "boolean" }, "lastLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "firmLink": { "description": "The ID of the copy owned by the firm if exists.", "type": "integer", "example": 1234 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" }, "api.v2.person.counts.nal": { "title": "Person Counts NAL", "properties": { "profile": { "properties": { "positions": { "type": "integer" }, "education": { "type": "integer" } }, "type": "object" }, "emails": { "type": "integer" }, "phones": { "type": "integer" }, "addresses": { "type": "integer" }, "links": { "type": "integer" } }, "type": "object" }, "api.v2.person.counts": { "title": "Person Counts", "allOf": [ { "$ref": "#/components/schemas/api.person.counts.nal" }, { "properties": { "researchNotes": { "type": "integer" }, "systemNotes": { "type": "integer" }, "gdprNotes": { "type": "integer" }, "tasks": { "type": "integer" }, "pendingTasks": { "type": "integer" }, "doneTasks": { "type": "integer" }, "meetings": { "type": "integer" }, "upcomingMeetings": { "type": "integer" }, "pastMeetings": { "type": "integer" }, "attachments": { "type": "integer" }, "customValues": { "type": "integer" }, "tags": { "type": "integer" }, "emails": { "type": "integer" }, "forms": { "type": "integer" } }, "type": "object", "property": "manager" }, { "properties": { "companies": { "type": "integer" }, "lists": { "type": "integer" }, "custom": { "type": "integer" }, "billings": { "type": "integer" }, "assignments": { "type": "integer" }, "opportunities": { "type": "integer" }, "candidatesLists": { "type": "integer" } }, "type": "object", "property": "relationships" } ] }, "api.v2.dueDiligenceCheck": { "title": "Due Diligence Check", "properties": { "id": { "type": "integer", "example": 1234 }, "note": { "type": "string", "example": "Some additional note" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "phraseId": { "type": "integer", "example": 1234 }, "phraseName": { "type": "string", "example": "Fraud" }, "histories": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.dueDiligenceHistory" } } }, "type": "object" }, "api.v2.dueDiligenceFlag": { "title": "Due Diligence Flag", "required": [ "status" ], "properties": { "id": { "type": "integer", "example": 1234 }, "status": { "type": "integer", "example": "1" }, "statusTitle": { "type": "string", "example": "No Concerns" }, "statusTranslation": { "type": "string", "example": "No Concerns" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.dueDiligenceHistory" } } }, "type": "object" }, "api.v2.dueDiligenceHistory": { "title": "Due Diligence History", "properties": { "id": { "type": "integer", "example": 1234 }, "actionType": { "type": "string", "example": "due_diligence_check or due_diligence_flag" }, "actionId": { "type": "integer", "example": 1234 }, "note": { "type": "string", "example": "Some note added" }, "status": { "type": "integer", "example": "1" }, "statusTitle": { "type": "string", "example": "No Concerns" }, "statusTranslation": { "type": "string", "example": "No Concerns" }, "actor": { "type": "string", "example": "John Doe" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" } }, "type": "object" }, "api.v3.person.basic": { "title": "Person Object", "properties": { "id": { "description": "Class CandidatePosition", "type": "integer", "example": 1234 }, "firstname": { "type": "string", "example": "Jane" }, "lastname": { "type": "string", "example": "Doe" }, "fullname": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "api.v3.person.position": { "title": "Person Position", "properties": { "id": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Director of Communication" }, "career": { "$ref": "#/components/schemas/api.career" }, "classification": { "$ref": "#/components/schemas/api.classification" }, "company": { "description": "The company that the person works for. If they are not linked to an existing record this object will just contain the `name` of the company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "location": { "$ref": "#/components/schemas/api.location" }, "teamSize": { "$ref": "#/components/schemas/api.teamSize" }, "teamSizeId": { "$ref": "#/components/schemas/api.teamSizeId" }, "industry": { "$ref": "#/components/schemas/api.industry" }, "department": { "type": "string", "example": "Finance" }, "companyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/api.companyType" } }, "startDate": { "type": "string", "example": "2011-08-14" }, "endDate": { "type": "string", "example": "2018-03-25" }, "skills": { "type": "array", "items": { "type": "string", "example": "Good at managing finances." } }, "achievements": { "type": "array", "items": { "type": "string", "example": "Managed all the finances." } }, "summary": { "type": "string", "example": "Summary of the position" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "primary": { "type": "boolean" }, "tense": { "description": "`true` if the position is current", "type": "boolean" }, "startMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `startDate` field", "type": "boolean" }, "endMonthUnknown": { "description": "If this is `true` then ignore the month and day part of the `endDate` field", "type": "boolean" }, "updatedAt": { "description": "updated date returned person last updated", "type": "string" } }, "type": "object" }, "api.v3.person.currentStatus": { "title": "Current Status", "properties": { "careers": { "description": "Class CandidateCurrentStatus", "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "classification": { "$ref": "#/components/schemas/api.classification" }, "positionType": { "$ref": "#/components/schemas/api.positionType" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/api.location" } }, "status": { "properties": { "value": { "$ref": "#/components/schemas/api.aspiration.status.value" }, "name": { "$ref": "#/components/schemas/api.aspiration.status.text" } }, "type": "object" } }, "type": "object" }, "api.v3.company": { "title": "Company", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.v3.company.meta" }, "manager": { "$ref": "#/components/schemas/api.v3.company.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "company" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "consultants": { "type": "object" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.researcher" } }, "officeGroups": { "$ref": "#/components/schemas/api.list.officeGroup" }, "regions": { "$ref": "#/components/schemas/api.list.region" }, "label": { "type": "string", "example": "company" }, "division": { "type": "string", "example": "The division or subsidiary of the company" }, "description": { "type": "string", "example": "The description of the company" }, "speciality": { "type": "string", "example": "The specialities of the company" }, "size": { "type": "string", "example": "The size of the company" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "addresses": { "$ref": "#/components/schemas/api.address" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "relationships": { "properties": { "contacts": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "projects": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Chief Technology Officer - London" } }, "type": "object" }, "opportunities": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "New Opportunity" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" } ] }, "api.v3.company.manager": { "title": "Company Manager Items", "properties": { "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "status": { "$ref": "#/components/schemas/api.status.simple" } }, "type": "object" }, "api.v3.company.meta": { "title": "Company Meta Items", "properties": { "archived": { "type": "boolean" }, "boardexId": { "type": "integer", "example": 1234 }, "order": { "type": "integer", "example": 3 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "watching": { "description": "Shows if the authenticated user is watching this company", "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/api.company.meta.permission" } }, "type": "object" }, "api.v3.company.meta.permission": { "title": "Company Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v3.company.countableFields": { "title": "Company Counts", "type": "string", "enum": [ "links", "manager.researchNotes", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.documents", "manager.customValues", "manager.articles", "relationships.contacts", "relationships.opportunities", "relationships.projects" ] }, "api.v3.company.field": { "title": "Company Fields", "type": "string", "enum": [ "consultants.users", "consultants.office_groups", "consultants.regions", "manager.pendingTasks", "manager.upcomingTask", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.researchNotes", "manager.systemNotes", "manager.documents", "manager.customValues", "manager.status", "relationships.contacts", "relationships.projects", "relationships.opportunities" ] }, "api.v3.person.default": { "title": "Person Default", "properties": { "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "person" }, "label": { "type": "string", "example": "person" }, "name": { "type": "string", "example": "Jane Doe" }, "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "summary": { "type": "string", "example": "Jane Doe has previously worked for ..." }, "profilePicture": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "aliases": { "type": "array", "items": { "type": "string", "example": "Doey" } }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/api.email" } }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/api.phone" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "profile": { "description": "The person profile", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.person.nal": { "title": "Person NAL", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.person.profile" }, "meta": { "$ref": "#/components/schemas/api.person.meta.nal" }, "counts": { "$ref": "#/components/schemas/api.person.counts.nal" } }, "type": "object" } ] }, "api.v3.person.full": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.v3.person.profile" }, "relationships": { "$ref": "#/components/schemas/api.v3.person.relationships" }, "manager": { "$ref": "#/components/schemas/api.v3.person.manager" }, "meta": { "$ref": "#/components/schemas/api.person.meta" }, "counts": { "$ref": "#/components/schemas/api.person.counts" } }, "type": "object" } ] }, "api.v3.person": { "title": "Person", "anyOf": [ { "$ref": "#/components/schemas/api.v3.person.default" }, { "$ref": "#/components/schemas/api.v3.person.full" } ] }, "api.v3.person.countableFields": { "title": "Person Counts", "type": "string", "enum": [ "emails", "addresses", "phones", "links", "profile.positions", "profile.education", "profile.documents", "profile.languages", "relationships.listsAsContact", "relationships.opportunitiesAsContact", "relationships.assignmentsAsContact", "relationships.listsAsCandidate", "relationships.opportunitiesAsCandidate", "relationships.assignmentsAsCandidate", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v3.person.field": { "title": "Person Fields", "type": "string", "enum": [ "aliases", "profile.aspirations", "profile.confidential", "profile.currentStatus", "profile.positions", "profile.education", "profile.documents", "profile.languages", "profile.headline", "relationships.listsAsContact", "relationships.opportunitiesAsContact", "relationships.assignmentsAsContact", "relationships.listsAsCandidate", "relationships.opportunitiesAsCandidate", "relationships.assignmentsAsCandidate", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v3.person.candidate": { "title": "Person Fields", "type": "string", "enum": [ "meta.candidate" ] }, "api.v3.person.fieldWithCandidate": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.v3.person.field" }, { "$ref": "#/components/schemas/api.v3.person.candidate" } ] }, "api.v3.person.profile": { "title": "Person Profile", "properties": { "aspirations": { "$ref": "#/components/schemas/api.person.aspiration" }, "currentStatus": { "$ref": "#/components/schemas/api.v3.person.currentStatus" }, "confidential": { "$ref": "#/components/schemas/api.person.confidential" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.language" } }, "headline": { "type": "string", "example": "Candidate Headline" } }, "type": "object" }, "api.v3.person.relationships": { "title": "Person Relationships", "properties": { "billings": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.billing" } }, "listsAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.listInfo" } }, "assignmentsAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.assignmentInfo" } }, "opportunitiesAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.opportunityInfo" } }, "listsAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.listInfo" } }, "assignmentsAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.assignmentInfo" } }, "opportunitiesAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.opportunityInfo" } } }, "type": "object" }, "api.v3.person.billing": { "title": "Person Billing Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.v3.person.manager": { "title": "Person Manager Items", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "attendeeMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } } }, "type": "object" }, "api.v3.person.meta": { "title": "Person Meta Info", "properties": { "watching": { "description": "Shows if the authenticated user is watching this person", "type": "boolean" }, "completion": { "$ref": "#/components/schemas/api.person.meta.completion" }, "permissions": { "$ref": "#/components/schemas/api.person.meta.permission" }, "archived": { "type": "boolean" }, "offLimitAgreements": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "dueDiligenceFlag": { "$ref": "#/components/schemas/api.v3.dueDiligenceFlag" }, "dueDiligenceChecks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.dueDiligenceCheck" } } }, "type": "object" }, "api.v3.person.meta.candidate": { "title": "Person Meta Info In Assignment Context", "allOf": [ { "$ref": "#/components/schemas/api.person.meta" }, { "properties": { "candidate": { "$ref": "#/components/schemas/api.v3.person.meta.candidateInfo" } }, "type": "object" } ] }, "api.v3.person.meta.completion": { "title": "Person Completion Info", "description": "Information on how complete the profile information is", "properties": { "id": { "type": "integer", "example": 1234 }, "score": { "description": "A percentage score indicating how complete the profile is", "type": "integer" }, "ignored": { "description": "Indicates if the incomplete status should be ignored", "type": "boolean" } }, "type": "object" }, "api.v3.person.meta.candidateInfo": { "title": "Person Candidate Info", "description": "Information of the person in the context of an project.", "properties": { "rank": { "description": "Where the person has been manually ranked in the project", "type": "integer", "example": 1 }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "addedBy": { "type": "string", "example": "Jane Doe" }, "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" }, "api.v3.person.meta.permission": { "title": "Person Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v3.person.meta.nal": { "title": "Person Meta Info", "properties": { "connected": { "description": "Whether or not the person is connected to the authenticated firm.", "type": "boolean" }, "lastLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "firmLink": { "description": "The ID of the copy owned by the firm if exists.", "type": "integer", "example": 1234 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" }, "api.v3.person.counts.nal": { "title": "Person Counts NAL", "properties": { "profile": { "properties": { "positions": { "type": "integer" }, "education": { "type": "integer" } }, "type": "object" }, "emails": { "type": "integer" }, "phones": { "type": "integer" }, "addresses": { "type": "integer" }, "links": { "type": "integer" } }, "type": "object" }, "api.v3.person.counts": { "title": "Person Counts", "allOf": [ { "$ref": "#/components/schemas/api.person.counts.nal" }, { "properties": { "researchNotes": { "type": "integer" }, "systemNotes": { "type": "integer" }, "gdprNotes": { "type": "integer" }, "tasks": { "type": "integer" }, "pendingTasks": { "type": "integer" }, "doneTasks": { "type": "integer" }, "meetings": { "type": "integer" }, "upcomingMeetings": { "type": "integer" }, "pastMeetings": { "type": "integer" }, "attachments": { "type": "integer" }, "customValues": { "type": "integer" }, "tags": { "type": "integer" }, "emails": { "type": "integer" }, "forms": { "type": "integer" } }, "type": "object", "property": "manager" }, { "properties": { "companies": { "type": "integer" }, "lists": { "type": "integer" }, "custom": { "type": "integer" }, "billings": { "type": "integer" }, "assignments": { "type": "integer" }, "opportunities": { "type": "integer" }, "candidatesLists": { "type": "integer" } }, "type": "object", "property": "relationships" } ] }, "api.v3.dueDiligenceCheck": { "title": "Due Diligence Check", "properties": { "id": { "type": "integer", "example": 1234 }, "note": { "type": "string", "example": "Some additional note" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "phraseId": { "type": "integer", "example": 1234 }, "phraseName": { "type": "string", "example": "Fraud" }, "histories": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.dueDiligenceHistory" } } }, "type": "object" }, "api.v3.dueDiligenceFlag": { "title": "Due Diligence Flag", "required": [ "status" ], "properties": { "id": { "type": "integer", "example": 1234 }, "status": { "type": "integer", "example": "1" }, "statusTitle": { "type": "string", "example": "No Concerns" }, "statusTranslation": { "type": "string", "example": "No Concerns" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "histories": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.dueDiligenceHistory" } } }, "type": "object" }, "api.v3.dueDiligenceHistory": { "title": "Due Diligence History", "properties": { "id": { "type": "integer", "example": 1234 }, "actionType": { "type": "string", "example": "due_diligence_check or due_diligence_flag" }, "actionId": { "type": "integer", "example": 1234 }, "note": { "type": "string", "example": "Some note added" }, "status": { "type": "integer", "example": "1" }, "statusTitle": { "type": "string", "example": "No Concerns" }, "statusTranslation": { "type": "string", "example": "No Concerns" }, "actor": { "type": "string", "example": "John Doe" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2021-09-01 12:00:00" } }, "type": "object" }, "api.v3.note": { "title": "Note", "properties": { "id": { "description": "Class NoteResource", "type": "integer", "example": 1234 }, "author": { "type": "string", "example": "Jane Doe" }, "text": { "type": "string", "example": "An example note." }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "pinned": { "type": "boolean", "example": "true" }, "groupCode": { "description": "The shared code between notes that were created at once.", "type": "string" }, "subNotes": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "notable": { "$ref": "#/components/schemas/api.notableInfo" }, "context": { "$ref": "#/components/schemas/api.notableInfo" } }, "type": "object" }, "api.v3.note.default": { "title": "Note Default", "properties": { "id": { "type": "integer", "example": 1234 }, "author": { "type": "string", "example": "Jane Doe" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "text": { "type": "string", "example": "An example note." }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "type": { "type": "string", "enum": [ "user", "system", "compliance", "feedback" ] } }, "type": "object" }, "api.v3.note.user": { "title": "User Note", "allOf": [ { "$ref": "#/components/schemas/api.v3.note.default" }, { "properties": { "pinned": { "type": "boolean", "example": "true" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "notable": { "$ref": "#/components/schemas/api.notableInfo" }, "context": { "$ref": "#/components/schemas/api.notableInfo" }, "groupCode": { "description": "The shared code between notes that were created at once.", "type": "string" } }, "type": "object" } ] }, "api.v3.note.system": { "title": "System Note", "allOf": [ { "$ref": "#/components/schemas/api.v3.note.default" }, { "properties": { "subNotes": { "type": "array", "items": { "type": "string" } }, "groupCode": { "description": "The shared code between notes that were created at once.", "type": "string" } }, "type": "object" } ] }, "api.v3.note.compliance": { "title": "Compliance Note", "allOf": [ { "$ref": "#/components/schemas/api.v3.note.default" } ] }, "api.v3.note.feedback": { "title": "Feedback Note", "allOf": [ { "$ref": "#/components/schemas/api.v3.note.default" }, { "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "notable": { "$ref": "#/components/schemas/api.notableInfo" }, "context": { "$ref": "#/components/schemas/api.notableInfo" }, "groupCode": { "description": "Client portal feedback notes (only on people for now)", "type": "string" } }, "type": "object" } ] }, "api.v3.project.actions": { "title": "Project Action Tags", "properties": { "id": { "description": "Class ProjectActionResource", "type": "integer", "example": 1234 }, "days": { "description": "Number of days before the task needs to be repeated", "type": "integer", "example": 22 }, "repeating": { "type": "boolean" }, "emailAlert": { "description": "Alert assignees of the task when it is completed/deleted", "type": "boolean" }, "taskName": { "type": "string", "example": "Follow up email" }, "color": { "type": "string", "example": "#12ab12" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "assignee": { "$ref": "#/components/schemas/api.researcher" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.assignmentInfo": { "title": "Project Info", "properties": { "id": { "description": "Class ProjectInfoResource", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "Assignment" }, "label": { "type": "string", "example": "Assignment" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v3.opportunityInfo": { "title": "Project Info", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "Opportunity" }, "label": { "type": "string", "example": "Opportunity" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v3.listInfo": { "title": "Project Info", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "List" }, "label": { "type": "string", "example": "List" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v3.project.default": { "title": "Project", "properties": { "id": { "description": "Class ProjectResource", "type": "integer", "example": 1234 }, "label": { "type": "string", "example": "assignment" }, "dataType": { "type": "string", "example": "assignment" }, "title": { "type": "string", "example": "Chief Technology Officer - London" }, "projectId": { "type": "string", "example": "project123" }, "description": { "type": "string", "example": "project description" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "careers": { "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "manager": { "$ref": "#/components/schemas/api.v3.project.manager" }, "meta": { "$ref": "#/components/schemas/api.v3.project.meta" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "start_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "relationships": { "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" } }, "type": "object" } }, "type": "object" }, "api.v3.project.countableFields": { "title": "Project Counts", "type": "string", "enum": [ "manager.researchNotes", "manager.systemNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom" ] }, "api.v3.project.field": { "title": "Project Fields", "type": "string", "enum": [ "consultants.users", "consultants.office_groups", "consultants.regions", "completion", "industries", "careers", "manager.researchNotes", "manager.mostRecentResearcherNote", "manager.systemNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.pastMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom" ] }, "api.v3.company.simple": { "title": "Simple Company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "color": { "type": "string", "example": "#abcabc" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.project.manager": { "title": "Project Manager Items", "properties": { "status": { "$ref": "#/components/schemas/api.status" }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "attendedMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "mostRecentResearcherNote": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } } }, "type": "object" }, "api.v3.project.meta": { "title": "Project Meta Items", "properties": { "watching": { "type": "boolean" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "archived": { "type": "boolean" } }, "type": "object" }, "api.v3.task": { "title": "Task Object", "properties": { "id": { "description": "Class TaskResource", "type": "integer", "example": 1234 }, "userId": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the task" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "note": { "type": "string", "example": "Task Note" }, "timezone": { "type": "string", "example": "Europe/London" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "done": { "type": "boolean", "example": true }, "priority": { "type": "integer", "example": 2 }, "private": { "type": "boolean", "example": true }, "pinned": { "type": "boolean", "example": true }, "lastPinned": { "type": "boolean", "example": true }, "recursion": { "description": "How the task repeats", "type": "array", "items": { "$ref": "#/components/schemas/api.task.recursion" } }, "action": { "description": "Only relevant for tasks on leads", "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.action" } }, "channels": { "description": "An array of channels that belong to the task", "type": "array", "items": { "$ref": "#/components/schemas/api.calendarable" } }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "api.v3.task.field": { "title": "Task Fields", "type": "string", "enum": [ "feedbacks", "action" ] }, "api.v3.task.action": { "title": "Task Action", "properties": { "id": { "type": "integer", "example": 1234 }, "project": { "type": "integer", "example": 1234 } }, "type": "object" }, "api.v3.officeGroup": { "title": "Office Group", "properties": { "id": { "description": "Class OfficeGroupResource", "type": "integer", "example": 1234 }, "firmId": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "An Office Group" }, "description": { "type": "string", "example": "A description" }, "invoicesCount": { "type": "integer", "example": 1234 }, "revenuesCount": { "type": "integer", "example": 1234 }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup.user" } }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region" } } }, "type": "object" }, "api.v3.officeGroup.user": { "title": "Office Group User", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jim Brown" }, "email": { "type": "string", "example": "me@example.com" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.region": { "title": "Region", "properties": { "id": { "description": "Class RegionResource", "type": "integer", "example": 1234 }, "firmId": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "A Region" }, "description": { "type": "string", "example": "A description" }, "officeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.region.user" } } }, "type": "object" }, "api.v3.region.user": { "title": "Region User", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jim Brown" }, "email": { "type": "string", "example": "me@example.com" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.billing": { "title": "Billing Object", "properties": { "id": { "type": "integer", "example": 1234 }, "brief_id": { "type": "integer", "example": 1234 }, "client_id": { "type": "integer", "example": 1234 }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.default" } }, "revenues": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.billing.revenue" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.invoice.default" } }, "fixedFees": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.billing.fixedFee" } } }, "type": "object" }, "api.v3.billing.fixedFee": { "title": "Billing Fixed Fee Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "refNumber": { "type": "string", "example": "ref1234" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "recipient": { "$ref": "#/components/schemas/api.billing.recipient" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "project": { "properties": { "label": { "type": "string", "example": "assignment" }, "id": { "type": "integer", "example": "123" }, "projectId": { "type": "string", "example": "project123" } }, "type": "object" }, "note": { "type": "string", "example": "This is a note" }, "isFixedFee": { "type": "boolean" } }, "type": "object" }, "api.v3.invoice.default": { "title": "Billing Invoice Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "invoicedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "sentAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "refNumber": { "type": "string", "example": "ref1234" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "items": { "$ref": "#/components/schemas/api.invoiceItem" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "template": { "properties": { "id": { "type": "integer", "example": "1234" }, "name": { "type": "string", "example": "Default Template" }, "firmName": { "type": "string", "example": "ACME" }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "address": { "type": "string", "example": "123 Catton Court" }, "website": { "type": "string", "example": "https://example.com" }, "taxPercent": { "type": "number", "format": "float", "example": "20.0" }, "taxType": { "type": "number", "format": "float", "example": "20.0" }, "incremental": { "type": "boolean" }, "numberPattern": { "type": "string", "example": "EZ0001" }, "nextNumber": { "type": "string", "example": "EZ0002" }, "lastNumber": { "type": "string", "example": "EZ0001" }, "paymentTerms": { "type": "integer", "example": "30" }, "footer": { "type": "string", "example": "Invoice footer" }, "addedBy": { "type": "string", "example": "John Smith" }, "note": { "type": "string", "example": "This is a note" }, "title": { "type": "string", "example": "Invoice" }, "altTitle": { "type": "string", "example": "Credit Note" }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "taxType": { "type": "string", "example": "VAT" }, "taxPercent": { "type": "string", "example": "20" }, "filename": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.v3.invoice.relationships" } }, "type": "object" }, "api.v3.invoice.full": { "title": "Invoice Full", "allOf": [ { "properties": { "": { "$ref": "#/components/schemas/api.v3.invoice.default" }, "relationships": { "$ref": "#/components/schemas/api.v3.invoice.relationships" } }, "type": "object" } ] }, "api.v3.invoice.relationships": { "title": "Invoice Relationships", "properties": { "revenue": { "$ref": "#/components/schemas/api.v3.billing.revenue" }, "contact": { "$ref": "#/components/schemas/api.person.default" }, "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.v3.invoice.countableFields": { "title": "Invoice Counts", "type": "string", "enum": [ "relationships.percentSplits" ] }, "api.v3.invoice.field": { "title": "Invoice Fields", "type": "string", "enum": [ "relationships.contact", "relationships.company", "relationships.project", "relationships.percentSplit", "relationships.revenue" ] }, "api.v3.billing.revenue": { "title": "Billing Revenue Object", "properties": { "id": { "type": "integer", "example": "1234" }, "date": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "probability": { "type": "integer", "example": "30" }, "refNumber": { "type": "string" }, "note": { "type": "string" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.revenue.relationships" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.revenue.relationships": { "title": "Revenue Relationships", "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.v3.revenue.field": { "title": "Revenue Fields", "type": "string", "enum": [ "relationships.company", "relationships.project", "relationships.percentSplits" ] }, "api.v3.search.user": { "title": "Search Firm User Object", "properties": { "id": { "description": "Class SearchFirmUserResource", "type": "integer", "example": 1234 }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "email": { "type": "string", "example": "me@example.com" }, "phone": { "type": "string", "example": "01234 567890" }, "firstLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "lastLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "label": { "type": "string", "example": "user" }, "disabled": { "type": "boolean" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "role": { "type": "string", "example": "search" }, "relationships": { "$ref": "#/components/schemas/api.v3.search.user.relationships" }, "hasApiTokens": { "type": "boolean" } }, "type": "object" }, "api.v3.search.user.relationships": { "title": "Search Firm User Relationships", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.projects" } }, "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.projects" } }, "lists": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.projects" } }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.companies" } }, "people": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.people" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.invoices" } }, "revenues": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.revenues" } }, "delegates": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.delegates" } }, "officeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.officeGroup" } } }, "type": "object" }, "api.v3.search.user.projects": { "title": "Search Firm User Projects", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.companies": { "title": "Search Firm User Companies", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Acme Inc" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.people": { "title": "Search Firm User People", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jim Brown" }, "email": { "type": "string", "example": "me@example.com" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.invoices": { "title": "Search Firm User Invoices", "properties": { "id": { "type": "integer", "example": 1234 }, "invoiceNumber": { "type": "string", "example": "123456" }, "formattedTotal": { "type": "string", "example": "1000.70" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.revenues": { "title": "Search Firm User Revenues", "properties": { "id": { "type": "integer", "example": 1234 }, "formattedTotal": { "type": "string", "example": "1000.70" }, "assignment": { "type": "string", "example": "Managing Director" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.delegates": { "title": "Search Firm User Delegates", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jim Brown" }, "email": { "type": "string", "example": "me@example.com" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v3.search.user.field": { "title": "Search Firm User Fields", "type": "string", "enum": [ "relationships.assignments", "relationships.opportunities", "relationships.lists", "relationships.companies", "relationships.people", "relationships.invoices", "relationships.revenues", "relationships.delegates", "relationships.officeGroups", "hasApiTokens" ] }, "api.v4.list": { "title": "List", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.v4.list.meta" }, "manager": { "$ref": "#/components/schemas/api.v4.list.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "list" }, "name": { "type": "string", "example": "Potential Clients" }, "owner": { "$ref": "#/components/schemas/api.v4.owner" }, "owners": { "$ref": "#/components/schemas/api.v4.owner" }, "relationships": { "$ref": "#/components/schemas/api.v4.list.relationships" }, "pipeline": { "$ref": "#/components/schemas/api.list.pipelineTask" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "health": { "type": "integer", "example": 23 }, "bucketStats": { "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.stats.tag" } }, "onTarget": { "description": "The number of people that are on target", "type": "integer", "example": 4 }, "overdue": { "description": "The number of people that are overdue", "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } ] }, "api.v4.list.field": { "title": "List Fields", "type": "string", "enum": [ "owners", "manager.researchNotes", "manager.systemNotes", "manager.documents", "relationships.people" ] }, "api.v4.list.manager": { "title": "List Manager Items", "properties": { "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } } }, "type": "object" }, "api.v4.list.relationships": { "title": "Lists Relationships", "properties": { "people": { "$ref": "#/components/schemas/api.person.default" } }, "type": "object" }, "api.v4.list.meta": { "title": "List Meta Items", "properties": { "watching": { "type": "boolean" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "archived": { "type": "boolean" } }, "type": "object" }, "api.v4.company": { "title": "Company", "type": "object", "allOf": [ { "properties": { "meta": { "$ref": "#/components/schemas/api.v4.company.meta" }, "manager": { "$ref": "#/components/schemas/api.v4.company.manager" }, "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "company" }, "name": { "type": "string", "example": "Amazon" }, "aliases": { "type": "array", "items": { "type": "string", "example": "amzn" } }, "owner": { "$ref": "#/components/schemas/api.v4.owner" }, "owners": { "$ref": "#/components/schemas/api.v4.owner" }, "label": { "type": "string", "example": "company" }, "division": { "type": "string", "example": "The division or subsidiary of the company" }, "description": { "type": "string", "example": "The description of the company" }, "speciality": { "type": "string", "example": "The specialities of the company" }, "size": { "type": "string", "example": "The size of the company" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "phone": { "type": "string", "example": "+123 456 789" }, "email": { "type": "string", "example": "me@example.com" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "addresses": { "$ref": "#/components/schemas/api.address" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "relationships": { "properties": { "contacts": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "projects": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Chief Technology Officer - London" } }, "type": "object" }, "opportunities": { "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "New Opportunity" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" } ] }, "api.v4.company.manager": { "title": "Company Manager Items", "properties": { "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "status": { "$ref": "#/components/schemas/api.status.simple" } }, "type": "object" }, "api.v4.company.meta": { "title": "Company Meta Items", "properties": { "archived": { "type": "boolean" }, "boardexId": { "type": "integer", "example": 1234 }, "altrataId": { "type": "string", "example": "1-org-123456789" }, "order": { "type": "integer", "example": 3 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "watching": { "description": "Shows if the authenticated user is watching this company", "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/api.company.meta.permission" } }, "type": "object" }, "api.v4.company.meta.permission": { "title": "Company Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v4.company.countableFields": { "title": "Company Counts", "type": "string", "enum": [ "links", "manager.researchNotes", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.documents", "manager.customValues", "manager.articles", "relationships.contacts", "relationships.opportunities", "relationships.projects" ] }, "api.v4.company.field": { "title": "Company Fields", "type": "string", "enum": [ "owners", "manager.pendingTasks", "manager.upcomingTask", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.researchNotes", "manager.systemNotes", "manager.documents", "manager.customValues", "manager.status", "relationships.contacts", "relationships.projects", "relationships.opportunities" ] }, "api.v4.person.default": { "title": "Person Default", "properties": { "id": { "type": "integer", "example": 1234 }, "dataType": { "type": "string", "example": "person" }, "label": { "type": "string", "example": "person" }, "name": { "type": "string", "example": "Jane Doe" }, "honorific": { "type": "string", "example": "Ms." }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "summary": { "type": "string", "example": "Jane Doe has previously worked for ..." }, "profilePicture": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.v4.owner" }, "owners": { "$ref": "#/components/schemas/api.v4.owner" }, "aliases": { "type": "array", "items": { "type": "string", "example": "Doey" } }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/api.email" } }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/api.phone" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/api.link" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/api.address" } }, "profile": { "description": "The person profile", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.person.nal": { "title": "Person NAL", "allOf": [ { "$ref": "#/components/schemas/api.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.person.profile" }, "meta": { "$ref": "#/components/schemas/api.person.meta.nal" }, "counts": { "$ref": "#/components/schemas/api.person.counts.nal" } }, "type": "object" } ] }, "api.v4.person.full": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.v4.person.default" }, { "properties": { "linkedinIdentifier": { "type": "string" }, "xingIdentifier": { "type": "string" }, "profile": { "$ref": "#/components/schemas/api.v4.person.profile" }, "relationships": { "$ref": "#/components/schemas/api.v4.person.relationships" }, "manager": { "$ref": "#/components/schemas/api.v4.person.manager" }, "meta": { "$ref": "#/components/schemas/api.person.meta" }, "counts": { "$ref": "#/components/schemas/api.person.counts" } }, "type": "object" } ] }, "api.v4.person": { "title": "Person", "anyOf": [ { "$ref": "#/components/schemas/api.v4.person.default" }, { "$ref": "#/components/schemas/api.v4.person.full" } ] }, "api.v4.person.countableFields": { "title": "Person Counts", "type": "string", "enum": [ "emails", "addresses", "phones", "links", "profile.positions", "profile.education", "profile.documents", "profile.languages", "relationships.listsAsContact", "relationships.opportunitiesAsContact", "relationships.assignmentsAsContact", "relationships.listsAsCandidate", "relationships.opportunitiesAsCandidate", "relationships.assignmentsAsCandidate", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v4.person.field": { "title": "Person Fields", "type": "string", "enum": [ "owners", "aliases", "profile.aspirations", "profile.confidential", "profile.currentStatus", "profile.positions", "profile.education", "profile.documents", "profile.languages", "profile.headline", "relationships.listsAsContact", "relationships.opportunitiesAsContact", "relationships.assignmentsAsContact", "relationships.listsAsCandidate", "relationships.opportunitiesAsCandidate", "relationships.assignmentsAsCandidate", "relationships.billings", "manager.tags", "manager.pendingTasks", "manager.tasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attendeeMeetings", "manager.researchNotes", "manager.attachments", "manager.customValues" ] }, "api.v4.person.candidate": { "title": "Person Fields", "type": "string", "enum": [ "meta.candidate" ] }, "api.v4.person.fieldWithCandidate": { "title": "Person Full", "allOf": [ { "$ref": "#/components/schemas/api.v4.person.field" }, { "$ref": "#/components/schemas/api.v4.person.candidate" } ] }, "api.v4.person.profile": { "title": "Person Profile", "properties": { "aspirations": { "$ref": "#/components/schemas/api.person.aspiration" }, "currentStatus": { "$ref": "#/components/schemas/api.v3.person.currentStatus" }, "confidential": { "$ref": "#/components/schemas/api.person.confidential" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.position" } }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.education" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.language" } }, "headline": { "type": "string", "example": "Candidate Headline" } }, "type": "object" }, "api.v4.person.relationships": { "title": "Person Relationships", "properties": { "billings": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.billing" } }, "listsAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.listInfo" } }, "assignmentsAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.assignmentInfo" } }, "opportunitiesAsContact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.opportunityInfo" } }, "listsAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.listInfo" } }, "assignmentsAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.assignmentInfo" } }, "opportunitiesAsCandidate": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.opportunityInfo" } } }, "type": "object" }, "api.v4.person.billing": { "title": "Person Billing Relationship", "properties": { "id": { "type": "integer", "example": 1234 }, "meta": { "properties": { "archived": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "api.v4.person.manager": { "title": "Person Manager Items", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "attendeeMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "researchNotes": { "type": "array", "items": { "$ref": "#/components/schemas/api.note" } }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } } }, "type": "object" }, "api.v4.person.meta": { "title": "Person Meta Info", "properties": { "watching": { "description": "Shows if the authenticated user is watching this person", "type": "boolean" }, "completion": { "$ref": "#/components/schemas/api.person.meta.completion" }, "permissions": { "$ref": "#/components/schemas/api.person.meta.permission" }, "archived": { "type": "boolean" }, "offLimitAgreements": { "type": "array", "items": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "dueDiligenceFlag": { "$ref": "#/components/schemas/api.v3.dueDiligenceFlag" }, "dueDiligenceChecks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.dueDiligenceCheck" } } }, "type": "object" }, "api.v4.person.meta.candidate": { "title": "Person Meta Info In Assignment Context", "allOf": [ { "$ref": "#/components/schemas/api.person.meta" }, { "properties": { "candidate": { "$ref": "#/components/schemas/api.v4.person.meta.candidateInfo" } }, "type": "object" } ] }, "api.v4.person.meta.completion": { "title": "Person Completion Info", "description": "Information on how complete the profile information is", "properties": { "id": { "type": "integer", "example": 1234 }, "score": { "description": "A percentage score indicating how complete the profile is", "type": "integer" }, "ignored": { "description": "Indicates if the incomplete status should be ignored", "type": "boolean" } }, "type": "object" }, "api.v4.person.meta.candidateInfo": { "title": "Person Candidate Info", "description": "Information of the person in the context of an project.", "properties": { "rank": { "description": "Where the person has been manually ranked in the project", "type": "integer", "example": 1 }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "addedBy": { "type": "string", "example": "Jane Doe" }, "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" }, "api.v4.person.meta.permission": { "title": "Person Permissions", "description": "The permissions for each action that the authenticated user can perform", "properties": { "create": { "$ref": "#/components/schemas/api.permission" }, "edit": { "$ref": "#/components/schemas/api.permission" }, "manage": { "$ref": "#/components/schemas/api.permission" }, "delete": { "$ref": "#/components/schemas/api.permission" } }, "type": "object" }, "api.v4.person.meta.nal": { "title": "Person Meta Info", "properties": { "connected": { "description": "Whether or not the person is connected to the authenticated firm.", "type": "boolean" }, "lastLogin": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "firmLink": { "description": "The ID of the copy owned by the firm if exists.", "type": "integer", "example": 1234 }, "offLimitAgreement": { "$ref": "#/components/schemas/api.offLimits.agreement" } }, "type": "object" }, "api.v4.person.counts.nal": { "title": "Person Counts NAL", "properties": { "profile": { "properties": { "positions": { "type": "integer" }, "education": { "type": "integer" } }, "type": "object" }, "emails": { "type": "integer" }, "phones": { "type": "integer" }, "addresses": { "type": "integer" }, "links": { "type": "integer" } }, "type": "object" }, "api.v4.person.counts": { "title": "Person Counts", "allOf": [ { "$ref": "#/components/schemas/api.person.counts.nal" }, { "properties": { "researchNotes": { "type": "integer" }, "systemNotes": { "type": "integer" }, "gdprNotes": { "type": "integer" }, "tasks": { "type": "integer" }, "pendingTasks": { "type": "integer" }, "doneTasks": { "type": "integer" }, "meetings": { "type": "integer" }, "upcomingMeetings": { "type": "integer" }, "pastMeetings": { "type": "integer" }, "attachments": { "type": "integer" }, "customValues": { "type": "integer" }, "tags": { "type": "integer" }, "emails": { "type": "integer" }, "forms": { "type": "integer" } }, "type": "object", "property": "manager" }, { "properties": { "companies": { "type": "integer" }, "lists": { "type": "integer" }, "custom": { "type": "integer" }, "billings": { "type": "integer" }, "assignments": { "type": "integer" }, "opportunities": { "type": "integer" }, "candidatesLists": { "type": "integer" } }, "type": "object", "property": "relationships" } ] }, "api.v4.meeting": { "title": "Meeting Object", "properties": { "id": { "description": "The meeting ID", "type": "integer", "example": 1234 }, "userId": { "description": "The user's ID", "type": "integer", "example": 1234 }, "title": { "description": "The meeting title", "type": "string", "example": "Meeting Title" }, "assignees": { "description": "The meeting invitees", "type": "array", "items": { "$ref": "#/components/schemas/api.assignee" } }, "tag": { "$ref": "#/components/schemas/api.v4.status.simple" }, "tags": { "description": "The meeting tags", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.status.simple" } }, "private": { "description": "Is the meeting private?", "type": "boolean", "example": true }, "sensitivity": { "description": "Is the meeting sensitive?", "type": "boolean", "example": true }, "allDay": { "description": "Is it an all day meeting?", "type": "boolean", "example": true }, "organizer": { "description": "The organizer's name and email", "type": "string", "example": "Jane Doe " }, "isOrganizer": { "type": "boolean", "example": true }, "pinned": { "description": "Is the meeting pinned?", "type": "boolean", "example": true }, "sendInvite": { "type": "boolean", "example": true }, "note": { "description": "The meeting note", "type": "string", "example": "Meeting Note" }, "timezone": { "description": "The meeting timezone", "type": "string", "example": "Europe/London" }, "date": { "description": "The meeting start date/time", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end": { "description": "The meeting end date/time", "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "address": { "description": "The address of the meeting", "type": "string", "example": "123 The Street" }, "agenda": { "description": "The meeting agenda", "type": "string", "example": "What are we doing?" }, "details": { "description": "The meeting details", "type": "string", "example": "Here's how it went." }, "includeDetails": { "description": "Include additional details in the email", "type": "boolean" }, "includeName": { "description": "Include person name in the email", "type": "boolean" }, "documents": { "description": "An array of documents to attach to the meeting", "type": "array", "items": { "$ref": "#/components/schemas/api.document" } }, "context": { "description": "An array of context that belong to the meeting", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.calendarable" } }, "teamsMeeting": { "description": "Is this a Teams meeting?", "type": "boolean" }, "teamsUrl": { "description": "The Teams URL", "properties": { "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "string", "example": "https://teams.microsoft.com/l/meetup-join/..." } }, "type": "object" }, "api.v4.meeting.field": { "title": "Meeting Fields", "type": "string", "enum": [ "feedbacks", "documents" ] }, "api.v4.project.actions": { "title": "Project Action Tags", "properties": { "id": { "description": "Class ProjectActionResource", "type": "integer", "example": 1234 }, "days": { "description": "Number of days before the task needs to be repeated", "type": "integer", "example": 22 }, "repeating": { "type": "boolean" }, "emailAlert": { "description": "Alert assignees of the task when it is completed/deleted", "type": "boolean" }, "taskName": { "type": "string", "example": "Follow up email" }, "color": { "type": "string", "example": "#12ab12" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "tags": { "description": "The task tags", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.status.simple" } }, "assignee": { "$ref": "#/components/schemas/api.researcher" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.assignmentInfo": { "title": "Project Info", "properties": { "id": { "description": "Class ProjectInfoResource", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "Assignment" }, "label": { "type": "string", "example": "Assignment" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "owners": { "$ref": "#/components/schemas/api.v4.owner" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v4.opportunityInfo": { "title": "Project Info", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "Opportunity" }, "label": { "type": "string", "example": "Opportunity" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v4.listInfo": { "title": "Project Info", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "CTO" }, "projectId": { "type": "string", "example": "123abc" }, "dataType": { "type": "string", "example": "List" }, "label": { "type": "string", "example": "List" }, "company": { "type": "string", "example": "Amazon" }, "owner": { "type": "string", "example": "Jane Doe" }, "status": { "$ref": "#/components/schemas/api.status" }, "meta": { "properties": { "dateAdded": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } } }, "type": "object" } }, "type": "object" }, "api.v4.project.default": { "title": "Project", "properties": { "id": { "description": "Class ProjectResource", "type": "integer", "example": 1234 }, "label": { "type": "string", "example": "assignment" }, "dataType": { "type": "string", "example": "assignment" }, "title": { "type": "string", "example": "Chief Technology Officer - London" }, "projectId": { "type": "string", "example": "project123" }, "description": { "type": "string", "example": "project description" }, "owner": { "$ref": "#/components/schemas/api.v4.owner" }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/api.industry" } }, "careers": { "type": "array", "items": { "$ref": "#/components/schemas/api.career" } }, "manager": { "$ref": "#/components/schemas/api.v4.project.manager" }, "meta": { "$ref": "#/components/schemas/api.v4.project.meta" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "start_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end_date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "relationships": { "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" } }, "type": "object" } }, "type": "object" }, "api.v4.project.countableFields": { "title": "Project Counts", "type": "string", "enum": [ "manager.researchNotes", "manager.systemNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.pastMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom" ] }, "api.v4.project.field": { "title": "Project Fields", "type": "string", "enum": [ "owners", "completion", "industries", "careers", "billing", "manager.researchNotes", "manager.mostRecentResearcherNote", "manager.systemNotes", "manager.tasks", "manager.pendingTasks", "manager.doneTasks", "manager.meetings", "manager.upcomingMeetings", "manager.upcomingMeeting", "manager.pastMeetings", "manager.attachments", "manager.customValues", "relationships.candidates", "relationships.people", "relationships.custom" ] }, "api.v4.company.simple": { "title": "Simple Company", "properties": { "id": { "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Amazon" }, "image": { "properties": { "url": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "color": { "type": "string", "example": "#abcabc" } }, "type": "object" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.project.manager": { "title": "Project Manager Items", "properties": { "status": { "$ref": "#/components/schemas/api.status.simple" }, "pendingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "upcomingTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "doneTasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task.simple" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.task" } }, "meetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting" } }, "upcomingMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "pastMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "attendedMeetings": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.meeting.simple" } }, "researchNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "mostRecentResearcherNote": { "$ref": "#/components/schemas/api.notesCollection" }, "systemNotes": { "$ref": "#/components/schemas/api.notesCollection" }, "customValues": { "type": "array", "items": { "$ref": "#/components/schemas/api.customValue" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.document" } } }, "type": "object" }, "api.v4.project.meta": { "title": "Project Meta Items", "properties": { "watching": { "type": "boolean" }, "following": { "type": "boolean" }, "pinned": { "type": "boolean" }, "archived": { "type": "boolean" } }, "type": "object" }, "api.v4.meeting.simple": { "title": "Simple Meeting Object", "properties": { "id": { "description": "Class SimpleMeetingResource", "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the thing" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "end": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "note": { "type": "string", "example": "Task Note" }, "address": { "type": "string", "example": "123 The Street" }, "agenda": { "type": "string", "example": "What are we doing?" }, "details": { "type": "string", "example": "Here's how it went." }, "private": { "type": "boolean" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "tags": { "description": "The meeting tags", "type": "array", "items": { "$ref": "#/components/schemas/api.status.simple" } }, "owners": { "type": "array", "items": { "properties": { "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.status.simple": { "title": "Simple Status Object", "properties": { "id": { "description": "Class SimpleStatusTagResource", "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "Identified" }, "color": { "type": "string", "example": "#12AB12" } }, "type": "object" }, "api.v4.task.simple": { "title": "Simple Task Object", "properties": { "id": { "description": "Class SimpleTaskResource", "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the thing" }, "done": { "type": "boolean" }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "note": { "type": "string", "example": "Task Note" }, "private": { "type": "boolean" }, "pipeline": { "description": "Only relevant for tasks on leads", "type": "array", "items": { "$ref": "#/components/schemas/api.task.pipeline" } }, "tag": { "$ref": "#/components/schemas/api.v4.status.simple" }, "tags": { "description": "The task tags", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.status.simple" } }, "recursion": { "description": "How the task repeats", "type": "array", "items": { "$ref": "#/components/schemas/api.task.recursion" } }, "owners": { "type": "array", "items": { "properties": { "fullName": { "type": "string", "example": "Jane Doe" } }, "type": "object" } }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.task": { "title": "Task Object", "properties": { "id": { "description": "Class TaskResource", "type": "integer", "example": 1234 }, "userId": { "type": "integer", "example": 1234 }, "title": { "type": "string", "example": "Do the task" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "note": { "type": "string", "example": "Task Note" }, "timezone": { "type": "string", "example": "Europe/London" }, "tag": { "$ref": "#/components/schemas/api.v4.status.simple" }, "tags": { "description": "The task tags", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.status.simple" } }, "date": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "done": { "type": "boolean", "example": true }, "priority": { "type": "integer", "example": 2 }, "private": { "type": "boolean", "example": true }, "pinned": { "type": "boolean", "example": true }, "lastPinned": { "type": "boolean", "example": true }, "recursion": { "description": "How the task repeats", "type": "array", "items": { "$ref": "#/components/schemas/api.task.recursion" } }, "pipeline": { "description": "Only relevant for tasks on leads", "type": "array", "items": { "$ref": "#/components/schemas/api.task.pipeline" } }, "context": { "description": "An array of context that belong to the task", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.calendarable" } }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "api.v4.task.field": { "title": "Task Fields", "type": "string", "enum": [ "feedbacks", "pipeline" ] }, "api.v4.task.pipeline": { "title": "Task Pipeline", "properties": { "id": { "type": "integer", "example": 1234 }, "bucket": { "type": "integer", "example": 1234 } }, "type": "object" }, "api.v4.calendarable": { "title": "Calendarable Object", "properties": { "id": { "description": "Class CalendarableResource", "type": "integer", "example": 1234 }, "type": { "type": "string", "example": "assignment" }, "label": { "type": "string", "example": "assignment" }, "name": { "type": "string", "example": "Chief Technology Officer - London" }, "owner": { "$ref": "#/components/schemas/api.v4.owner" }, "owners": { "description": "An array of owners related to the calendarable", "type": "array", "items": { "$ref": "#/components/schemas/api.v4.owner" } } }, "type": "object" }, "api.v4.billing": { "title": "Billing Object", "properties": { "id": { "type": "integer", "example": 1234 }, "brief_id": { "type": "integer", "example": 1234 }, "client_id": { "type": "integer", "example": 1234 }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.default" } }, "revenues": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.billing.revenue" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.invoice.default" } }, "fixedFees": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.billing.fixedFee" } } }, "type": "object" }, "api.v4.billing.fixedFee": { "title": "Billing Fixed Fee Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "refNumber": { "type": "string", "example": "ref1234" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "recipient": { "$ref": "#/components/schemas/api.billing.recipient" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "project": { "properties": { "label": { "type": "string", "example": "assignment" }, "id": { "type": "integer", "example": "123" }, "projectId": { "type": "string", "example": "project123" } }, "type": "object" }, "note": { "type": "string", "example": "This is a note" }, "isFixedFee": { "type": "boolean" } }, "type": "object" }, "api.v4.invoice.default": { "title": "Billing Invoice Object", "properties": { "id": { "type": "integer", "example": "1234" }, "billingId": { "type": "integer", "example": "1234" }, "invoicedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "paidAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "sentAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "dueDate": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "refNumber": { "type": "string", "example": "ref1234" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "items": { "$ref": "#/components/schemas/api.invoiceItem" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "template": { "properties": { "id": { "type": "integer", "example": "1234" }, "name": { "type": "string", "example": "Default Template" }, "firmName": { "type": "string", "example": "ACME" }, "logo": { "type": "string", "example": "https://cloud.notactivelylooking.com/1234" }, "address": { "type": "string", "example": "123 Catton Court" }, "website": { "type": "string", "example": "https://example.com" }, "taxPercent": { "type": "number", "format": "float", "example": "20.0" }, "taxType": { "type": "number", "format": "float", "example": "20.0" }, "incremental": { "type": "boolean" }, "numberPattern": { "type": "string", "example": "EZ0001" }, "nextNumber": { "type": "string", "example": "EZ0002" }, "lastNumber": { "type": "string", "example": "EZ0001" }, "paymentTerms": { "type": "integer", "example": "30" }, "footer": { "type": "string", "example": "Invoice footer" }, "addedBy": { "type": "string", "example": "John Smith" }, "note": { "type": "string", "example": "This is a note" }, "title": { "type": "string", "example": "Invoice" }, "altTitle": { "type": "string", "example": "Credit Note" }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" } }, "type": "object" }, "taxType": { "type": "string", "example": "VAT" }, "taxPercent": { "type": "string", "example": "20" }, "filename": { "type": "string", "example": "https://cloud.notactivelylooking.com/123" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.v4.invoice.relationships" } }, "type": "object" }, "api.v4.invoice.full": { "title": "Invoice Full", "allOf": [ { "properties": { "": { "$ref": "#/components/schemas/api.v4.invoice.default" }, "relationships": { "$ref": "#/components/schemas/api.v4.invoice.relationships" } }, "type": "object" } ] }, "api.v4.invoice.relationships": { "title": "Invoice Relationships", "properties": { "revenue": { "$ref": "#/components/schemas/api.v4.billing.revenue" }, "contact": { "$ref": "#/components/schemas/api.person.default" }, "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.v4.invoice.countableFields": { "title": "Invoice Counts", "type": "string", "enum": [ "relationships.percentSplits" ] }, "api.v4.invoice.field": { "title": "Invoice Fields", "type": "string", "enum": [ "relationships.contact", "relationships.company", "relationships.project", "relationships.percentSplit", "relationships.revenue" ] }, "api.v4.billing.revenue": { "title": "Billing Revenue Object", "properties": { "id": { "type": "integer", "example": "1234" }, "date": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "total": { "properties": { "amount": { "type": "number", "format": "float", "example": "50.30" }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "tag": { "$ref": "#/components/schemas/api.status.simple" }, "probability": { "type": "integer", "example": "30" }, "refNumber": { "type": "string" }, "note": { "type": "string" }, "lockedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "owner": { "$ref": "#/components/schemas/api.researcher" }, "creator": { "$ref": "#/components/schemas/api.researcher" }, "relationships": { "$ref": "#/components/schemas/api.revenue.relationships" }, "createdAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "updatedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" } }, "type": "object" }, "api.v4.revenue.relationships": { "title": "Revenue Relationships", "properties": { "company": { "$ref": "#/components/schemas/api.company.simple" }, "project": { "$ref": "#/components/schemas/api.v1.assignmentInfo" }, "percentSplits": { "$ref": "#/components/schemas/api.billing.feeSplit" } }, "type": "object" }, "api.v4.revenue.field": { "title": "Revenue Fields", "type": "string", "enum": [ "relationships.company", "relationships.project", "relationships.percentSplits" ] }, "api.automaticNumber": { "title": "Project ID Automatic Numbering", "properties": { "id": { "type": "integer", "example": 1234 }, "primary": { "type": "boolean" }, "numberPattern": { "type": "string", "example": "PROJ-10000" }, "lastNumber": { "type": "string", "example": "PROJ-10056" }, "nextNumber": { "type": "string", "example": "PROJ-10057" }, "createdAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" }, "updatedAt": { "type": "string", "example": "2021-03-19T18:25:46.000000Z" } }, "type": "object" }, "api.relationships": { "title": "Relationship Object", "properties": { "assignments": { "description": "Class Relationship", "type": "array", "items": { "$ref": "#/components/schemas/api.relationships.projects" } }, "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships.projects" } }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships.companies" } }, "people": { "type": "array", "items": { "$ref": "#/components/schemas/api.relationships.people" } } }, "type": "object" }, "api.relationships.single": { "title": "Relationship Object", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/api.relationships.projects" }, { "$ref": "#/components/schemas/api.relationships.companies" }, { "$ref": "#/components/schemas/api.relationships.people" } ] }, "api.relationships.default": { "title": "Relationship Object", "properties": { "id": { "type": "integer", "example": 1234 }, "addedAt": { "type": "string", "example": "2021-04-30T08:53:20.000000Z" }, "note": { "type": "string", "example": "Relationship Note" }, "relationship": { "type": "integer", "example": 1234 }, "label": { "type": "string", "example": "Related" } }, "type": "object" }, "api.relationships.projects": { "title": "Relationship projects", "description": "Return an array of projects belonging to the relationship.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.relationships.default" }, { "properties": { "name": { "type": "string", "example": "Head of Acme Enterprises" }, "company": { "type": "string", "example": "Acme Enterprises Ltd" }, "image": { "type": "string", "example": "logo.jpg" } }, "type": "object" } ] }, "api.relationships.companies": { "title": "Relationship companies", "description": "Return an array of companies belonging to the relationship.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.relationships.default" }, { "properties": { "name": { "type": "string", "example": "Acme Enterprises Ltd" }, "company": { "type": "string", "example": "Acme Enterprises Ltd" }, "image": { "type": "string", "example": "logo.jpg" } }, "type": "object" } ] }, "api.relationships.people": { "title": "Relationship people", "description": "Return an array of people belonging to the relationship.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/api.relationships.default" }, { "properties": { "honorific": { "type": "string", "example": "Dr." }, "name": { "type": "string", "example": "Jane Doe" }, "firstName": { "type": "string", "example": "Jane" }, "lastName": { "type": "string", "example": "Doe" }, "fullName": { "type": "string", "example": "Jane Doe" }, "summary": { "type": "string", "example": "Jane Doe has previously worked for ..." }, "jobTitle": { "type": "string", "example": "Manager" }, "company": { "type": "string", "example": "Acme Enterprises Ltd" }, "personTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "pipelineTags": { "type": "array", "items": { "$ref": "#/components/schemas/api.status" } }, "assignmentCount": { "type": "integer", "example": "1" }, "opportunityCount": { "type": "integer", "example": "1" }, "listCount": { "type": "integer", "example": "1" } }, "type": "object" } ] }, "api.v4.owner": { "title": "Owner Object", "properties": { "id": { "description": "Class ResultsResource", "type": "integer", "example": 1234 }, "type": { "type": "string", "example": "user" }, "model": { "oneOf": [ { "$ref": "#/components/schemas/api.researcher" }, { "$ref": "#/components/schemas/api.list.officeGroup" }, { "$ref": "#/components/schemas/api.list.region" } ] }, "tags": { "$ref": "#/components/schemas/api.status" } }, "type": "object" }, "api.kpiDashboard.folder": { "properties": { "id": { "description": "Folder ID", "type": "integer" }, "searchFirmId": { "description": "ID of the search firm the folder belongs to", "type": "integer" }, "userId": { "description": "ID of the user who owns the folder", "type": "integer" }, "page": { "description": "Page identifier", "type": "string" }, "section": { "description": "Section identifier", "type": "string" }, "name": { "description": "Folder name", "type": "string" }, "createdAt": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/api.researcher" } }, "type": "object" }, "kpiDashboardPanel": { "description": "A single panel on a KPI dashboard, backed by a saved query.", "properties": { "id": { "description": "Client-generated panel identifier", "type": "string", "example": "a1b2c3" }, "row": { "description": "Zero-based index of the row the panel belongs to", "type": "integer", "example": 0 }, "title": { "description": "Panel title", "type": "string", "example": "Active people" }, "type": { "description": "The kind of metric the panel renders", "type": "string", "enum": [ "count", "sum", "average", "table", "graph" ], "example": "count" }, "queryId": { "description": "ID of the saved query powering the panel", "type": "integer", "example": 14 }, "savedQuery": { "description": "The saved query powering the panel, included when loaded", "type": "object", "nullable": true } }, "type": "object" }, "api.kpiDashboard": { "title": "KPI Dashboard", "description": "A KPI dashboard containing panels with metrics and data visualizations", "properties": { "id": { "description": "The dashboard ID", "type": "integer" }, "name": { "description": "The dashboard name", "type": "string" }, "description": { "description": "The dashboard description", "type": "string", "nullable": true }, "isGlobal": { "description": "Whether the dashboard is globally available", "type": "boolean" }, "rawData": { "description": "Dashboard panels grouped by row. Each element is a row, and each row is an array of panels.", "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/kpiDashboardPanel" } }, "example": [ [ { "id": "a1b2c3", "row": 0, "title": "Active people", "type": "count", "queryId": 14 }, { "id": "d4e5f6", "row": 0, "title": "Placements by month", "type": "graph", "queryId": 21 } ] ] }, "calculatedData": { "oneOf": [ { "$ref": "#/components/schemas/api.kpiDashboard.calculatedData" } ], "nullable": true }, "user": { "$ref": "#/components/schemas/api.researcher" }, "createdAt": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "refreshedAt": { "description": "The last time cached dashboard data was refreshed", "type": "string", "format": "date-time", "nullable": true }, "sharedWith": { "description": "Users, office groups and regions this dashboard is shared with", "type": "array", "items": { "$ref": "#/components/schemas/api.kpiDashboard.sharedWith" } }, "folder": { "oneOf": [ { "$ref": "#/components/schemas/api.kpiDashboard.folder" } ], "nullable": true, "description": "The folder containing this dashboard" } }, "type": "object" }, "api.kpiDashboard.panelResult": { "title": "KPI panel result", "description": "The calculated result for a single panel. Its shape depends on the panel `type`:\n * `count`, `sum` and `average` return a number; `graph` returns labelled series; `table` returns an array of rows.", "oneOf": [ { "description": "Result for `count`, `sum` or `average` panels", "type": "number", "example": 128 }, { "description": "Result for `graph` panels", "type": "object", "example": { "labels": [ "Jan", "Feb", "Mar" ], "series": [ { "name": "Placements", "data": [ 4, 7, 5 ] } ] } }, { "description": "Result for `table` panels", "type": "array", "items": { "type": "object" }, "example": [ { "fullname": "Jane Doe", "created_at": "2026-03-23" } ] } ] }, "api.kpiDashboard.calculatedData": { "title": "KPI Dashboard calculated data", "description": "Calculated metrics for the dashboard, included only when the `withCalculatedData` query parameter is present.\n * Keyed by row index, then by panel index within that row, mirroring the layout of `rawData`.", "type": "object", "example": [ [ 128, { "labels": [ "Jan", "Feb", "Mar" ], "series": [ { "name": "Placements", "data": [ 4, 7, 5 ] } ] } ] ], "additionalProperties": { "description": "A row, keyed by panel index", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/api.kpiDashboard.panelResult" } } }, "api.kpiDashboard.sharedWith": { "title": "Shared With Resource", "description": "Resource representing entities that content is shared with", "properties": { "id": { "description": "Class SharedWithResource", "type": "integer", "example": 1234 }, "type": { "type": "string", "enum": [ "user", "officeGroup", "region" ], "example": "user" }, "createdAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "updatedAt": { "type": "string", "example": "2022-07-31T00:00:00.000000Z" }, "model": { "description": "The entity model the content is shared with", "oneOf": [ { "$ref": "#/components/schemas/api.researcher" }, { "$ref": "#/components/schemas/api.list.officeGroup" }, { "$ref": "#/components/schemas/api.list.region" } ] } }, "type": "object" }, "api.relationshipLabel": { "title": "Relationship Label", "properties": { "id": { "description": "Class RelationshipLabel", "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "Works for" }, "default": { "type": "boolean", "example": true }, "inverse": { "$ref": "#/components/schemas/api.inverseRelationshipLabel" } }, "type": "object" }, "api.inverseRelationshipLabel": { "title": "Inverse Relationship Label", "properties": { "id": { "type": "integer", "example": 1234 }, "text": { "type": "string", "example": "Employee" } }, "type": "object" }, "api.dueDiligencePhrase": { "title": "Due Diligence Phrase", "properties": { "id": { "type": "integer", "example": 1234 }, "phrase": { "type": "string", "example": "Some Phrase" }, "seo": { "type": "string", "example": "some-phrase" }, "description": { "type": "string", "example": "Some additional description" }, "searchTerms": { "type": "array", "items": { "type": "string", "example": "word" } } }, "type": "object" }, "api.industry": { "title": "Industry", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LocalizationTrait" }, { "properties": { "name": { "description": "Class Industry", "type": "string", "example": "Life Sciences" }, "value": { "type": "string", "example": "Life Sciences" }, "parent_id": { "type": "integer", "example": "1234" } }, "type": "object" } ] }, "api.location": { "title": "Location", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LocalizationTrait" }, { "properties": { "lat": { "description": "Class Location", "type": "number", "format": "float", "example": 31.3 }, "long": { "type": "number", "format": "float", "example": 31.3 } }, "type": "object" } ] }, "api.422": { "title": "Invalid Data Response", "properties": { "errors": { "properties": { "[field_with_error]": { "type": "string", "example": "Description of the error" } }, "type": "object" }, "message": { "type": "string", "example": "The given data was invalid" } }, "type": "object" }, "api.currency": { "title": "Supported Currencies", "type": "string", "enum": [ "USD", "EUR", "CAD", "AUD", "CHF", "SEK", "ZAR", "DKK", "MXN", "PLN", "INR", "RUB", "CLP", "CZK", "GBP", "BGN", "COP", "ILS", "QAR", "SAR" ] }, "api.currencyAmount": { "title": "Currency Amount", "properties": { "amount": { "type": "number", "format": "float", "example": 50.3 }, "currency": { "$ref": "#/components/schemas/api.currency" } }, "type": "object" }, "api.person.storeFile": { "title": "Person Store with Resume Body", "required": [ "resume" ], "properties": { "resume": { "type": "string", "format": "binary" }, "ownerId": { "description": "The ID of the new owner of the person", "type": "integer", "nullable": true }, "lists": { "description": "An array of ids of the the lists that the person is in", "type": "array", "items": { "type": "integer" }, "nullable": true }, "projectId": { "description": "The ID of a project that the person will be added to as a candidate", "type": "integer" }, "projectType": { "description": "The project type", "type": "string", "enum": [ "assignment", "opportunity", "list" ] } }, "type": "object" }, "api.classification": { "title": "NED Classification", "description": "Class NedClassification", "allOf": [ { "$ref": "#/components/schemas/LocalizationTrait" } ] }, "api.notableInfo": { "title": "Basic Item Info", "properties": { "id": { "description": "Class Note", "type": "integer", "example": 1234 }, "type": { "type": "string", "enum": [ "person", "assignment", "opportunity", "list", "client", "company" ] }, "name": { "type": "string", "example": "Jane Doe" } }, "type": "object" }, "api.links": { "title": "Links", "description": "Useful links for accessing other pages.", "properties": { "first": { "description": "Fetch the first page of results.", "type": "string", "example": "https://ezekia.com/api" }, "last": { "description": "Fetch the last page of results.", "type": "string", "example": "https://ezekia.com/api" }, "next": { "description": "Fetch the next page of results.", "type": "string", "example": "https://ezekia.com/api" }, "prev": { "description": "Fetch the previous page of results.", "type": "string", "example": "https://ezekia.com/api" } }, "type": "object" }, "api.pageMeta": { "title": "Pagination meta data", "description": "Meta data about the results and pages", "properties": { "currentPage": { "description": "The current page returned.", "type": "integer", "example": 3 }, "lastPage": { "description": "The last page number.", "type": "integer", "example": 5 }, "from": { "description": "The index of the first item in this response.", "type": "integer", "example": 31 }, "to": { "description": "The index of the last item in this response.", "type": "integer", "example": 45 }, "path": { "description": "The base URL path for this route.", "type": "string", "example": "https://ezekia.com/api" }, "perPage": { "description": "The number of items returned in each page.", "type": "integer", "example": 15 }, "total": { "description": "The total number of results across all pages.", "type": "integer", "example": 66 }, "unfilteredTotal": { "description": "The total number of available items of this type.", "type": "integer", "example": 145 } }, "type": "object" }, "api.customField.value": { "title": "Custom Field Value", "anyOf": [ { "type": "string", "example": "Line or paragraph or single selection" }, { "type": "array", "items": { "type": "string", "example": "Checkboxes" } }, { "type": "boolean" }, { "type": "integer" } ] }, "api.offLimits.agreement.constraint": { "title": "Off Limit Agreement Constraint", "type": "string", "enum": [ "begins", "contains", "exact", "containsExact" ] }, "api.permission": { "title": "Access Level", "description": "A string indicating the access level of the authenticated user for a specific item or type of item.\n`always` - can access all items,\n`public` - can access all public items and items shared with the user,\n`shared` - can access only items shared with the user,\n`never` - cannot access any items.", "type": "string", "enum": [ "always", "public", "shared", "never" ] }, "api.task.recursion": { "title": "Task Recursion", "properties": { "type": { "$ref": "#/components/schemas/api.task.recursion.type" }, "frequency": { "description": "How many times to repeat", "type": "integer", "example": 5 }, "days": { "description": "An array of days of the week to repeat the task, starting with Sunday as 0", "type": "array", "items": { "type": "integer", "maximum": 6, "minimum": 0 } } }, "type": "object" }, "api.task.recursion.type": { "title": "Recursion Type", "type": "string", "enum": [ "days", "months", "weeks", "years" ] }, "api.customValue.store": { "title": "Custom Value Request Object", "description": "Custom value request object", "required": [ "fieldId", "value" ], "properties": { "fieldId": { "type": "integer", "example": 1234 }, "modelId": { "description": "The model id that the custom value is scoped to", "type": "integer", "example": 1234 }, "scopedModel": { "description": "The model type that the custom value is scoped to", "type": "string", "enum": [ "client", "project" ], "example": "client" }, "value": { "type": "string", "example": "Custom value text" } }, "type": "object" }, "api.customValue.update": { "title": "Custom Value Request Object", "description": "Custom value request object", "required": [ "id", "fieldId", "value" ], "properties": { "id": { "description": "The custom value id", "type": "integer", "example": 1234 }, "fieldId": { "description": "The custom field id", "type": "integer", "example": 1234 }, "modelId": { "description": "The model id that the custom value is scoped to", "type": "integer", "example": 1234 }, "scopedModel": { "description": "The model type that the custom value is scoped to", "type": "string", "enum": [ "client", "project" ], "example": "client" }, "value": { "type": "string", "example": "Custom value text" } }, "type": "object" }, "LocalizationTrait": { "title": "Categories", "properties": { "id": { "description": "Trait LocalizationTrait", "type": "integer", "example": 1234 }, "name": { "type": "string", "example": "Luxembourg" } }, "type": "object" }, "api.aspiration.status.value": { "title": "Aspiration Status Value", "description": "A scale from 0 to 4 indicating how actively the individual is looking for a new job. 0 is Not looking, 4 is actively looking.", "type": "integer", "example": 1 }, "api.aspiration.status.text": { "title": "Aspiration Status Text", "description": "How actively an individual is looking for a new position. (Translated to the specified language).", "type": "string", "enum": [ "Not Looking", "Happy where I am", "Not Actively Looking", "May be interested", "Looking" ] }, "api.email.label": { "title": "Email Labels", "description": "Class UserEmail", "type": "string", "enum": [ "private", "work", "other", "predicted" ] }, "api.phone.label": { "title": "Phone Labels", "description": "Class UserPhone", "type": "string", "enum": [ "assistant", "direct", "home", "manager", "mobile", "mobile-private", "mobile-work", "other", "private", "switchboard", "work", "billing" ] }, "api.teamSize": { "title": "Team Size", "description": "The size of the team (translated into the specified language).", "type": "string", "enum": [ "No Team", "Up to 10 People", "10+ People", "50+ People", "200+ People" ] }, "api.teamSizeId": { "title": "Team Size ID", "description": "A number representing the team size: 1 - 0, 2 - <10, 3 - >10, 4 - >50, 5 - >200", "type": "integer", "example": 1234 }, "api.positionType": { "title": "Position Type", "type": "string", "enum": [ "permanent", "interim", "parttime", "contract", "temporary", "ned" ] } }, "parameters": { "api.kpiDashboard.withCalculatedData": { "name": "withCalculatedData", "in": "query", "description": "Include the calculated metrics data for the dashboard's panels. This will return the cached values unless `refresh` parameter is present.", "required": false, "schema": { "type": "boolean" } }, "api.kpiDashboard.refresh": { "name": "refresh", "in": "query", "description": "Force a recalculation of the cached data instead of returning the cached values. Only applies when `withCalculatedData` is present. Without this parameter, the cached values will be returned which are calculated every 12 hours.", "required": false, "schema": { "type": "boolean" } }, "api.lead.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "taskDate", "addedAt", "lastName", "firstName", "fullName", "company", "createdAt", "updatedAt" ], "example": "createdAt" } }, "api.lead.status": { "name": "status", "in": "query", "description": "Filter people with a specified status in the context of the list.\n\n If more than one status is specified then results matching any of the status will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.list.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.list.field" }, "default": [] } }, "api.company.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.company.field" }, "default": [] } }, "api.company.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.company.field" }, "default": [] } }, "api.company.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.company.countableFields" }, "default": [] } }, "api.person.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.field" }, "default": [] } }, "api.person.fieldsWithCandidate": { "name": "fieldsWithCandidate", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.fieldWithCandidate" }, "default": [] } }, "api.person.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.field" }, "default": [] } }, "api.person.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.countableFields" }, "default": [] } }, "api.project.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.field" }, "default": [] } }, "api.project.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.field" }, "default": [] } }, "api.project.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by adding the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.countableFields" }, "default": [] } }, "api.task.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } }, "api.invoice.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.countableFields" }, "default": [] } }, "api.invoice.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.field" }, "default": [] } }, "api.invoice.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.invoice.field" }, "default": [] } }, "api.revenue.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.revenue.field" }, "default": [] } }, "api.v2.company.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.company.field" }, "default": [] } }, "api.v2.company.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.company.field" }, "default": [] } }, "api.v2.company.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.company.countableFields" }, "default": [] } }, "api.v2.person.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.field" }, "default": [] } }, "api.v2.person.fieldsWithCandidate": { "name": "fieldsWithCandidate", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v2.person.fieldWithCandidate" }, "default": [] } }, "api.v2.person.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.field" }, "default": [] } }, "api.v2.person.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.person.countableFields" }, "default": [] } }, "api.v3.company.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.company.field" }, "default": [] } }, "api.v3.company.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.company.field" }, "default": [] } }, "api.v3.company.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.company.countableFields" }, "default": [] } }, "api.v3.person.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.field" }, "default": [] } }, "api.v3.person.fieldsWithCandidate": { "name": "fieldsWithCandidate", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.fieldWithCandidate" }, "default": [] } }, "api.v3.person.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.field" }, "default": [] } }, "api.v3.person.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.person.countableFields" }, "default": [] } }, "api.v3.project.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.field" }, "default": [] } }, "api.v3.project.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.project.field" }, "default": [] } }, "api.v3.project.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by adding the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.project.countableFields" }, "default": [] } }, "api.v3.task.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.task.field" }, "default": [] } }, "api.v3.invoice.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.invoice.countableFields" }, "default": [] } }, "api.v3.invoice.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.invoice.field" }, "default": [] } }, "api.v3.invoice.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.invoice.field" }, "default": [] } }, "api.v3.revenue.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.revenue.field" }, "default": [] } }, "api.v3.search.user.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v3.search.user.field" }, "default": [] } }, "api.v4.list.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.list.field" }, "default": [] } }, "api.v4.company.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company.field" }, "default": [] } }, "api.v4.company.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company.field" }, "default": [] } }, "api.v4.company.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.company.countableFields" }, "default": [] } }, "api.v4.person.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.field" }, "default": [] } }, "api.v4.person.fieldsWithCandidate": { "name": "fieldsWithCandidate", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.fieldWithCandidate" }, "default": [] } }, "api.v4.person.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.field" }, "default": [] } }, "api.v4.person.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.person.countableFields" }, "default": [] } }, "api.v4.project.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.project.field" }, "default": [] } }, "api.v4.project.exclude": { "name": "exclude", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.project.field" }, "default": [] } }, "api.v4.project.counts": { "name": "counts", "in": "query", "description": "The count of any countable field can be included in the `counts` field by adding the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.project.countableFields" }, "default": [] } }, "api.v4.task.fields": { "name": "fields", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.task.field" }, "default": [] } }, "api.v4.invoice.counts": { "name": "counts[]", "in": "query", "description": "The count of any countable field can be included in the `counts` field by added the required fields to the `count` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.invoice.countableFields" }, "default": [] } }, "api.v4.invoice.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down requests.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.invoice.field" }, "default": [] } }, "api.v4.invoice.exclude": { "name": "exclude[]", "in": "query", "description": "Fields can be excluded by passing them into the `exclude` query parameter.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.invoice.field" }, "default": [] } }, "api.v4.revenue.fields": { "name": "fields[]", "in": "query", "description": "Fields can be included by passing them into the `fields` query parameter. Be careful as this will slow down request.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api.v4.revenue.field" }, "default": [] } }, "api.person.isCandidate": { "name": "isCandidate", "in": "query", "description": "Include only people that have been added as a candidate to an assignment.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, "api.person.onCompanies": { "name": "onCompanies", "in": "query", "description": "Include only people that work for a company record.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, "api.noteType": { "name": "noteType", "in": "query", "description": "Filter which type of note is returned. Compliance is only available for people records.", "schema": { "type": "string", "default": "`user`", "enum": [ "`user`", "`system`", "`compliance`", "`feedback`", "`linked`" ] }, "example": "user" }, "api.firm.noteType": { "name": "noteType", "in": "query", "description": "Filter which type of note is returned. Compliance is only available for people records.", "schema": { "type": "string", "default": "`user`", "enum": [ "`user`", "`system`", "`compliance`", "`feedback`" ] }, "example": "user" }, "api.note.notableId": { "name": "notableId", "in": "query", "description": "The id of the parent model", "schema": { "type": "integer" }, "example": "1234" }, "api.v3.note.notableTypes": { "name": "notableTypes[]", "in": "query", "description": "Filter the results by the type of parent model. Multiple types can be included by passing them into the `notableTypes` parameter. This field is required if the `notableId` parameter is provided.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "people", "companies", "assignments", "opportunities", "lists", "projects" ] }, "default": [] }, "example": [ "people" ] }, "api.note.contacts": { "name": "associatedPeople", "in": "query", "description": "Filter the results by people associated with user notes. The `noteType` parameter must be `user`\n\nIf more than one context is specified then results matching any of the context will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.note.companies": { "name": "associatedCompanies", "in": "query", "description": "Filter the results by companies associated with user notes. The `noteType` parameter must be `user`\n\nIf more than one context is specified then results matching any of the context will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.note.projects": { "name": "associatedProjects", "in": "query", "description": "Filter the results by projects associated with user notes. The `noteType` parameter must be `user`\n\nIf more than one context is specified then results matching any of the context will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.page": { "name": "page", "in": "query", "description": "Specify the page of items to be returned", "schema": { "type": "integer" } }, "api.count": { "name": "count", "in": "query", "description": "Specify how many records to be returned per page.", "schema": { "type": "integer" } }, "api.from": { "name": "from", "in": "query", "description": "Filter results where the id is greater than the value provided. Used together with `to` to retrieve records from a range.", "schema": { "type": "integer" } }, "api.to": { "name": "to", "in": "query", "description": "Filter results where the id is equal to or less than the value provided. Used together with `from` to retrieve records from a range.", "schema": { "type": "integer" } }, "api.ids": { "name": "ids[]", "in": "query", "description": "Filter results where the id is in the given array of ids. Should not be used with the `from` or `to` parameters.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.since": { "name": "since", "in": "query", "description": "Filter all results where a date (default is time created) is after a specified time.\n\nThe date can be in multiple formats, many human-readable strings are allowed, as well as several date formats (e.g. \"last month\", \"2021-03-02\", \"1620136853\" (epoch time in seconds only), etc.)", "schema": { "type": "string" } }, "api.before": { "name": "before", "in": "query", "description": "Filter all results where a date (default is time created) is before a specified time.\n\nThe date can be in multiple formats, many human-readable strings are allowed, as well as several date formats (e.g. \"last month\", \"2021-03-02\", \"1620136853\" (epoch time in seconds only), etc.)", "schema": { "type": "string" } }, "api.between": { "name": "between", "in": "query", "description": "Filter all results where a date (default is time created) is between two dates/times.\n\nThe dates can be in multiple formats, many human-readable strings are allowed, as well as several date formats (e.g. \"last month\", \"2021-03-02\", \"1620136853\" (epoch time in seconds only), etc.)", "schema": { "type": "string" } }, "api.tags": { "name": "tags[]", "in": "query", "description": "Filter the results with certain tags.\n\nIf more than one tag is specified then results matching any of the tags will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.note.tags": { "name": "tags", "in": "query", "description": "Filter the results with certain tags for user notes. The `noteType` parameter must be `user`\n\nIf more than one tag is specified then results matching any of the tags will be returned.", "schema": { "type": "array", "items": { "type": "integer", "example": 1234 }, "default": [] } }, "api.view": { "name": "view", "in": "query", "description": "Filter results based on how they are associated with the authenticated user.\n\n`region` will return all results that are shared with the authenticated user's regions.", "schema": { "type": "string", "enum": [ "mine", "following", "associated", "office", "region" ] } }, "api.withArchived": { "name": "withArchived", "in": "query", "description": "Archived items are not normally returned in the results. By setting this parameter they will be included.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, "api.archived": { "name": "archived", "in": "query", "description": "Archived items are not normally returned in the results. By setting this parameter the results will only be archived items.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, "api.query": { "name": "query", "in": "query", "description": "A query string to filter the results (the shorthand `q` can be used as well).\n\nThe `filterOn` query parameter allows you to specify the fields that should be affected by the query.", "schema": { "type": "string" }, "example": "Jane Doe" }, "api.sortOrder": { "name": "sortOrder", "in": "query", "description": "The direction of the sorted results.", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "example": "asc" }, "api.note.sortOrder": { "name": "sortOrder", "in": "query", "description": "The direction of the sorted results.", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "example": "asc" }, "api.fuzzy": { "name": "fuzzy", "in": "query", "description": "The `query` parameter will filter items that match exactly with the query string.\nBy adding the `fuzzy` parameter the matching will be less strict, accounting for typos.", "allowEmptyValue": true, "schema": { "type": "boolean" } }, "api.company.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "alias", "email", "owner", "industry", "division", "specialities", "link", "customFields", "status" ] }, "default": [], "example": [ "name" ] } }, "api.v4.company.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "alias", "email", "owner", "owners", "industry", "division", "specialities", "link", "customFields", "status" ] }, "default": [], "example": [ "name" ] } }, "api.company.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n * The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "name", "createdAt", "updatedAt" ], "example": "createdAt" } }, "api.feeSplits.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against in the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "refNumber", "splitAmount", "recipientAmount", "recipientName", "currency", "tag", "industries", "projectId", "projectName", "companyName", "companyEmail" ] }, "default": [], "example": [ "tag" ] } }, "api.feeSplits.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "tag", "createdAt", "updatedAt", "refNumber" ], "example": "createdAt" } }, "api.invoice.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against in the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "invoiceId", "refNumber", "currency", "amount", "tag", "owner", "industries", "projectId", "projectName", "companyName", "companyEmail" ] }, "default": [], "example": [ "tag" ] } }, "api.invoice.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "tag", "createdAt", "updatedAt", "invoiceId", "refNumber" ], "example": "createdAt" } }, "api.list.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "name", "createdAt", "updatedAt" ], "example": "createdAt" } }, "api.person.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "honorific", "fullName", "aliases", "email", "owner", "company", "currentCompany", "department", "location", "phone", "jobTitle", "currentJobTitle", "link", "tag", "customField", "address", "profileText" ] }, "default": [], "example": [ "fullName" ] } }, "api.v4.person.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "honorific", "fullName", "aliases", "email", "owner", "owners", "company", "currentCompany", "department", "location", "phone", "jobTitle", "currentJobTitle", "link", "tag", "customField", "address", "profileText" ] }, "default": [], "example": [ "fullName" ] } }, "api.v4.candidate.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "honorific", "fullName", "aliases", "email", "owner", "owners", "company", "currentCompany", "department", "location", "phone", "jobTitle", "currentJobTitle", "link", "tag", "tagRecent", "tagPriority", "customField", "address", "profileText" ] }, "default": [], "example": [ "fullName" ] } }, "api.person.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n\n The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "lastName", "firstName", "fullName", "company", "createdAt", "updatedAt", "salary" ], "example": "createdAt" } }, "api.project.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "owner", "projectId", "company", "industry", "career", "customField", "status" ] }, "default": [ "name" ], "example": [ "name" ] } }, "api.v4.project.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "owner", "owners", "projectId", "company", "industry", "career", "customField", "status" ] }, "default": [ "name" ], "example": [ "name" ] } }, "api.project.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\n\n The direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "name", "createdAt", "updatedAt", "status", "company", "projectId", "potential" ], "example": "createdAt" } }, "api.revenue.filterOn": { "name": "filterOn[]", "in": "query", "description": "The fields that should be matched against in the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "currency", "amount", "tag", "owner", "industries", "projectId", "projectName", "companyName", "refNumber" ] }, "default": [], "example": [ "tag" ] } }, "api.revenue.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "enum": [ "id", "tag", "createdAt", "updatedAt", "refNumber" ], "example": "createdAt" } }, "api.note.filterOn": { "name": "filterOn", "in": "query", "description": "The fields that should be matched against the `query` parameter.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "`text`", "`owner`" ] }, "default": [], "example": [ "text" ] } }, "api.note.sortBy": { "name": "sortBy", "in": "query", "description": "The field that should be used to sort the results.\nThe direction can be specified with the `sortOrder` parameter.", "schema": { "description": "The best match if the `query` parameter is used, otherwise they will be ordered by when they were added to the platform.", "type": "string", "default": "createdAt", "enum": [ "id", "`createdAt`", "`updatedAt`" ], "example": "createdAt" } } }, "examples": { "WithoutMicrosoftGraphIntegration": { "summary": "Without Microsoft Graph Integration", "value": { "title": "Q3 Target Review", "owners": [ { "id": 1234, "type": "candidate", "fullname": "Jane Doe", "email": "me@example.com" } ], "note": "John will attend!", "timezone": "Europe/London", "date": "2023-07-20 13:00:00", "end": "2023-07-20 14:00:00", "address": "London Office", "agenda": "We will discuss progress during Q3", "tag": 1234, "private": true, "sensitivity": true, "allDay": true, "details": "We will review Q3 and discuss Q4", "includeDetails": true, "includeName": true, "sendInvite": false, "microsoftGraphIntegrationId": 2, "channels": [ { "id": 1234, "label": "assignment" } ] } }, "WithMicrosoftGraphIntegration": { "summary": "With Microsoft Graph Integration", "value": { "note": "John will attend!", "tag": 1234, "private": true, "channels": [ { "id": 1234, "label": "assignment" } ] } }, "v4.WithoutMicrosoftGraphIntegration": { "summary": "Without Microsoft Graph Integration", "value": { "title": "Q3 Target Review", "assignees": [ { "id": 1234, "type": "candidate", "fullname": "Jane Doe", "email": "me@example.com" } ], "note": "John will attend!", "timezone": "Europe/London", "date": "2023-07-20 13:00:00", "end": "2023-07-20 14:00:00", "address": "London Office", "agenda": "We will discuss progress during Q3", "tag": 1234, "tags": [ 1234, 5678 ], "private": true, "sensitivity": true, "allDay": true, "details": "We will review Q3 and discuss Q4", "includeDetails": true, "includeName": true, "sendInvite": false, "microsoftGraphIntegrationId": 2, "context": [ { "id": 1234, "label": "assignment" } ] } }, "v4.WithMicrosoftGraphIntegration": { "summary": "With Microsoft Graph Integration", "value": { "note": "John will attend!", "tag": 1234, "tags": [ 1234, 5678 ], "private": true, "context": [ { "id": 1234, "label": "assignment" } ] } } }, "requestBodies": { "api.company.storeRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.company.store" } } } }, "api.company.updateRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.company.update" } } } }, "api.person.storeRequest": { "description": "The body for creating a new person.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.store" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.person.updateRequest": { "description": "The person details to be updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.update" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.project.storeRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.project.store" } } } }, "api.project.updateRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.project.update" } } } }, "api.v2.company.storeRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.company.store" } } } }, "api.v2.company.updateRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.company.update" } } } }, "api.v2.person.storeRequest": { "description": "The body for creating a new person.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.store" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v2.person.updateRequest": { "description": "The person details to be updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2.person.update" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v3.company.storeRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.company.store" } } } }, "api.v3.company.updateRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.company.update" } } } }, "api.v3.person.storeRequest": { "description": "The body for creating a new person.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.person.store" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v3.person.updateRequest": { "description": "The person details to be updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.person.update" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v3.project.storeRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.store" } } } }, "api.v3.project.updateRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.update" } } } }, "api.v4.company.storeRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.company.store" } } } }, "api.v4.company.updateRequest": { "description": "The body for creating a new company.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.company.update" } } } }, "api.v4.person.storeRequest": { "description": "The body for creating a new person.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.person.store" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v4.person.updateRequest": { "description": "The person details to be updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.person.update" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.person.storeFile" } } } }, "api.v4.project.storeRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.project.store" } } } }, "api.v4.project.updateRequest": { "description": "The body for creating a new project", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.project.update" } } } }, "api.candidate.profilePicture.storeRequest": { "description": "The body for uploading a profile picture to a person.", "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.candidate.profilePicture.storeRequest" } } } }, "api.fixedFeeStore": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.fixedFee.storeRequest" } } } }, "api.invoiceStore": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.storeRequest" } } } }, "api.lockInvoice": { "description": "The body for locking an invoice.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.invoice.lock" } } } }, "api.revenueStore": { "description": "The revenue body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.revenue.storeRequest" } } } }, "api.customValue.updateRequest": { "description": "The request body for adding/updating custom value on an item.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.customValue.storeRequest" } } } }, "api.documentRequest": { "description": "The document request body", "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/api.document.default" } } } }, "api.importEmailRequest": { "description": "The person email body", "required": true, "content": { "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.importEmail.default" }, { "properties": { "attachments": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.importEmail.default" }, { "properties": { "attachments": { "description": "An array of valid document urls", "type": "array", "items": { "type": "string", "example": "https://www.example.com/mail/attachments/document.pdf" } } }, "type": "object" } ] } } } }, "api.list.storeRequest": { "description": "The body for creating a new list.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.list.storeRequest" } } } }, "api.education.storeRequest": { "description": "The body for creating and updating a person's education", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.education.storeRequest" } } } }, "api.position.storeRequest": { "description": "The body for creating and updating a person's position", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.position.storeRequest" } } } }, "api.meetingRequestStore": { "description": "The meeting request body", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.meeting.default" } ] } }, "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.meeting.default" }, { "properties": { "attachments": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } ] } } } }, "api.meetingRequestUpdate": { "description": "The meeting request body", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.meeting.default" } ] }, "examples": { "WithoutMicrosoftGraphIntegration": { "$ref": "#/components/examples/WithoutMicrosoftGraphIntegration" }, "WithMicrosoftGraphIntegration": { "$ref": "#/components/examples/WithMicrosoftGraphIntegration" } } }, "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.meeting.default" }, { "properties": { "attachments": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } ] } } } }, "api.meetingRequestUpdatePinned": { "description": "The meeting pinned request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.meeting.updatePinned" } } } }, "api.noteRequest": { "description": "The note body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.note.storeRequest" } } } }, "api.taskRequestStore": { "description": "The task request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task.storeRequest" } } } }, "api.taskRequestUpdate": { "description": "The task request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task.update" } } } }, "api.taskRequestUpdateDone": { "description": "The task done request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task.updateDone" } } } }, "api.taskRequestUpdatePriority": { "description": "The task priority request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task.updatePriority" } } } }, "api.taskRequestUpdatePinned": { "description": "The task pinned request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.task.updatePinned" } } } }, "api.v3.billing.fixedFeeStore": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.fixedFee.storeRequest" } } } }, "api.v3.invoiceStore": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.invoice.storeRequest" } } } }, "api.v3.revenueStore": { "description": "The revenue body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.revenue.storeRequest" } } } }, "api.v3.consultant.storeRequest": { "description": "The body for adding a consultant to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.consultant.request.store" } } } }, "api.v3.officeGroup.storeRequest": { "description": "The body for adding an office group to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.officeGroup.request.store" } } } }, "api.v3.region.storeRequest": { "description": "The body for adding a region to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.region.request.store" } } } }, "api.v3.project.action.update": { "description": "The body for creating a new action tag", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v3.project.action.update" } } } }, "api.v4.billing.fixedFeeStore": { "description": "The fixed fee body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.fixedFee.storeRequest" } } } }, "api.v4.invoiceStore": { "description": "The invoice body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.invoice.storeRequest" } } } }, "api.v4.revenueStore": { "description": "The revenue body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.revenue.storeRequest" } } } }, "api.v4.owners.deleteRequest": { "description": "The body for deleting owner from a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.owner.request.delete" } } } }, "api.v4.meetingRequestStore": { "description": "The meeting request body", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.v4.meeting.default" } ] } }, "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.v4.meeting.default" }, { "properties": { "attachments": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } ] } } } }, "api.v4.meetingRequestUpdate": { "description": "The meeting request body", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.v4.meeting.default" } ] }, "examples": { "v4.WithoutMicrosoftGraphIntegration": { "$ref": "#/components/examples/v4.WithoutMicrosoftGraphIntegration" }, "v4.WithMicrosoftGraphIntegration": { "$ref": "#/components/examples/v4.WithMicrosoftGraphIntegration" } } }, "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/api.v4.meeting.default" }, { "properties": { "attachments": { "description": "An array of binary files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } ] } } } }, "api.v4.meetingRequestUpdatePinned": { "description": "The meeting pinned request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.meeting.updatePinned" } } } }, "api.v4.taskRequestStore": { "description": "The task request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task.storeRequest" } } } }, "api.v4.taskRequestUpdate": { "description": "The task request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task.update" } } } }, "api.v4.taskRequestUpdateDone": { "description": "The task done request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task.updateDone" } } } }, "api.v4.taskRequestUpdatePriority": { "description": "The task priority request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task.updatePriority" } } } }, "api.v4.taskRequestUpdatePinned": { "description": "The task pinned request body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.task.updatePinned" } } } }, "api.v4.owners.request": { "description": "The body for adding or updating owner to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.owner.request.store" } } } }, "api.v4.people.owners.request": { "description": "The body for adding or updating owner to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.people.owner.request.store" } } } }, "api.v4.ownerTag.request": { "description": "The body for adding or updating owner to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.ownerTag.request.store" } } } }, "api.v4.people.ownerTag.request": { "description": "The body for adding or updating owner to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.people.ownerTag.request.store" } } } }, "api.v4.project.action.update": { "description": "The body for creating a new action tag", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.project.action.update" } } } }, "api.v4.primary-owner.request": { "description": "The body for adding or updating primary owner of a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.primary-owner.request.store" } } } }, "api.v4.owners.indexRequest": { "description": "The body for adding an owner to a model.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v4.owners.request.index" } } } }, "api.relationships.storeDeleteRequest": { "description": "The body for creating and deleting a relationship", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.relationships.storeDelete" } } } }, "api.relationships.updateRequest": { "description": "The body for updating a relationship", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.relationships.update" } } } } }, "securitySchemes": { "api.bearer": { "type": "http", "bearerFormat": "string", "scheme": "bearer" } } }, "tags": [ { "name": "People (Profile)" }, { "name": "People (Confidential Details)" }, { "name": "People (Aspirations)" }, { "name": "People (Languages)" }, { "name": "People (Current Status)" }, { "name": "People (Emails)" }, { "name": "People (Phones)" }, { "name": "People (Links)" }, { "name": "People (Positions)" }, { "name": "People (Education/Qualifications)" }, { "name": "People (Notes)" }, { "name": "People (Lists)" }, { "name": "People (Import Emails)" }, { "name": "People (Status tags)" }, { "name": "Projects" }, { "name": "Projects (Candidates)" }, { "name": "Projects (Contacts)" }, { "name": "Billing" }, { "name": "Billing (Invoices)" }, { "name": "Billing (Revenues)" }, { "name": "Billing (Fixed Fees)" }, { "name": "Billing (Percent Splits)" }, { "name": "Companies" }, { "name": "Companies (Links)" }, { "name": "Clients" }, { "name": "Lists" }, { "name": "Notes" }, { "name": "Status tags" }, { "name": "Categories" }, { "name": "Custom Values" }, { "name": "Custom Fields" }, { "name": "Search Firm Users" }, { "name": "Off-Limits" }, { "name": "Documents" }, { "name": "Meetings" }, { "name": "Tasks" }, { "name": "Relationships" }, { "name": "Authentication", "description": "Authentication" }, { "name": "Target Companies", "description": "Target Companies" }, { "name": "Owners", "description": "Owners" }, { "name": "KPI Dashboards", "description": "KPI Dashboards" } ] }