Pipedrive Oauth

Links

    Pipedrive Oauth API

    Getting access, Developing, Testing

    Back to Pipedrive Oauth

    Search persons

    Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID.

    Input

    type: object properties: parameters: type: object properties: term: type: string description: >- The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. fields: type: string enum: - custom_fields - email - notes - phone - name description: >- A comma-separated string array. The fields to perform the search from. Defaults to all of them. exact_match: type: boolean enum: - true - false description: >- When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. organization_id: type: integer description: >- Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000. include_fields: type: string enum: - person.picture description: >- Supports including optional fields in the results which are not provided by default start: type: integer default: 0 description: >- Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. limit: type: integer description: Items shown per page required: - term

    Output

    title: searchPersonsResponse200 type: object properties: success: type: boolean description: If the response is successful or not data: type: object properties: items: type: array description: The array of found items items: type: object properties: result_score: type: number description: Search result relevancy item: type: object properties: id: type: integer description: The ID of the person type: type: string description: The type of the item name: type: string description: The name of the person phones: type: array description: An array of phone numbers items: type: string emails: type: array description: An array of email addresses items: type: string visible_to: type: integer description: The visibility of the person owner: type: object properties: id: type: integer description: The ID of the owner of the person organization: type: object properties: id: type: integer description: The ID of the organization the person is associated with name: type: string description: >- The name of the organization the person is associated with custom_fields: type: array description: Custom fields items: type: string notes: type: array description: An array of notes items: type: string additional_data: type: object properties: pagination: description: Pagination details of the list type: object properties: start: type: integer description: Pagination start limit: type: integer description: Items shown per page more_items_in_collection: type: boolean description: Whether there are more list items in the collection than displayed next_start: type: integer description: Next pagination start