diff --git a/openapi.yaml b/openapi.yaml index fdad41b..85c3f9f 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -320,8 +320,7 @@ paths: format: int32 - name: query in: query - required: false - description: "An optional value to filter the projects by name and address line 1" + description: "An optional value to do a full text search for projects" schema: type: string - name: modified_since @@ -329,6 +328,41 @@ paths: description: "An ISO8601 formatted date and time to return projects modified on or after the provided value" schema: type: string + - name: labels + in: query + description: "A comma delimited list of labels to filter projects by" + example: "active,todo" + schema: + type: string + - name: creator_id + in: query + description: "An optional value to filter projects by the user id who created the project" + schema: + type: string + - name: integration_type + in: query + description: "An optional value to filter projects by the integration type it was created from" + example: "Jobber" + schema: + type: string + - name: integration_relation_id + in: query + description: "An optional value to filter projects by the integration id associated with the project" + example: job-1234 + schema: + type: string + - name: primary_contact_email + in: query + description: "An optional value to filter projects by the primary contact email associated with the project" + example: joe@email.com + schema: + type: string + - name: primary_contact_phone_number + in: query + description: "An optional value to filter projects by the primary contact phone number associated with the project. Only numbers allowed" + example: "5551234444" + schema: + type: string responses: '200': description: 'List of projects sorted by most recent activity first' @@ -2219,6 +2253,11 @@ components: $ref: '#/components/schemas/Coordinate' primary_contact: $ref: '#/components/schemas/ProjectContactResponse' + labels: + type: array + description: "A list of labels associated with the project" + items: + $ref: '#/components/schemas/ProjectIntegration' created_at: type: integer format: int32