{
  "url": "https://telipot.com/catalog/capabilities/people.contacts.search",
  "id": "people.contacts.search",
  "description": "Contacts saved in the credential's own account that match a keyword, stage or label",
  "platform": "people",
  "providers": [
    {
      "slug": "apollo",
      "name": "Apollo"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "apollo.people.contacts.search",
      "name": "Saved contacts in the account by keyword, stage or label",
      "provider": {
        "slug": "apollo",
        "name": "Apollo"
      },
      "capability": "people.contacts.search",
      "platform": "people",
      "kind": "data",
      "tier": "core",
      "identity": "key",
      "identityLabel": "Your plan",
      "price": {
        "amount": "Free",
        "state": "free",
        "label": "Free",
        "detail": "Free from the tool",
        "type": "free"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "free",
      "live": true,
      "summary": "Use the search for contacts endpoint to search for the contacts that have been added to your team's Apollo account.",
      "method": "POST",
      "path": "/contacts/search",
      "host": "https://api.apollo.io/api/v1",
      "docsUrl": "https://docs.apollo.io/reference/search-for-contacts",
      "auth": {
        "scheme": "api_key",
        "label": "api_key · in header as x-api-key",
        "short": "api_key · x-api-key"
      },
      "scope": "own_account",
      "principal": "organization",
      "requiredScopes": [],
      "verification": {
        "state": "none",
        "label": "Not verified yet",
        "detail": "Not checked yet. We test with a real request before we mark it."
      },
      "input": [
        {
          "name": "q_keywords",
          "location": "body",
          "type": "string",
          "required": false,
          "constraints": [],
          "note": "Keywords over names, job titles, employers or company names, or email addresses. Examples: CEO; Sumware Software."
        },
        {
          "name": "contact_stage_ids",
          "location": "body",
          "type": "array",
          "required": false,
          "constraints": [],
          "note": "Apollo IDs of contact stages; a contact matches any one. List contact stages returns the IDs."
        },
        {
          "name": "contact_label_ids",
          "location": "body",
          "type": "array",
          "required": false,
          "constraints": [],
          "note": "Apollo IDs of labels; a contact matches any one."
        },
        {
          "name": "sort_by_field",
          "location": "body",
          "type": "string",
          "required": false,
          "constraints": [
            "one of \"contact_last_activity_date\", \"contact_email_last_opened_at\", \"contact_email_last_clicked_at\", \"contact_created_at\", \"contact_updated_at\""
          ],
          "note": "Sort field, most recent first."
        },
        {
          "name": "sort_ascending",
          "location": "body",
          "type": "boolean",
          "required": false,
          "constraints": [
            "default false"
          ],
          "note": "Set true for ascending order; needs sort_by_field."
        },
        {
          "name": "per_page",
          "location": "body",
          "type": "integer",
          "required": false,
          "constraints": [
            "1 to 100"
          ],
          "note": "Results per page, up to 100."
        },
        {
          "name": "page",
          "location": "body",
          "type": "integer",
          "required": false,
          "constraints": [
            "1 to 500"
          ],
          "note": "Page to return, up to 500 pages of 100; use with per_page."
        }
      ],
      "sampleInput": {},
      "inputSchema": {
        "type": "object",
        "properties": {
          "q_keywords": {
            "type": "string",
            "description": "Keywords over names, job titles, employers or company names, or email addresses. Examples: CEO; Sumware Software.",
            "examples": [
              "CEO"
            ]
          },
          "contact_stage_ids": {
            "type": "array",
            "description": "Apollo IDs of contact stages; a contact matches any one. List contact stages returns the IDs."
          },
          "contact_label_ids": {
            "type": "array",
            "description": "Apollo IDs of labels; a contact matches any one."
          },
          "sort_by_field": {
            "type": "string",
            "description": "Sort field, most recent first.",
            "enum": [
              "contact_last_activity_date",
              "contact_email_last_opened_at",
              "contact_email_last_clicked_at",
              "contact_created_at",
              "contact_updated_at"
            ]
          },
          "sort_ascending": {
            "type": "boolean",
            "description": "Set true for ascending order; needs sort_by_field.",
            "default": false
          },
          "per_page": {
            "type": "integer",
            "description": "Results per page, up to 100.",
            "examples": [
              10
            ],
            "minimum": 1,
            "maximum": 100
          },
          "page": {
            "type": "integer",
            "description": "Page to return, up to 500 pages of 100; use with per_page.",
            "examples": [
              1
            ],
            "minimum": 1,
            "maximum": 500
          }
        },
        "additionalProperties": false
      },
      "output": [
        {
          "name": "contacts",
          "type": "object[]"
        },
        {
          "name": "pagination",
          "type": "object"
        }
      ],
      "outputSchema": {
        "type": "object",
        "properties": {
          "contacts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "email_status": {
                  "type": "string"
                },
                "linkedin_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "organization_name": {
                  "type": "string"
                },
                "organization_id": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "contact_stage_id": {
                  "type": "string"
                },
                "owner_id": {
                  "type": "string"
                },
                "source": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                },
                "label_ids": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "phone_numbers": {
                  "type": "array"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer"
              },
              "per_page": {
                "type": "integer"
              },
              "total_entries": {
                "type": "integer"
              },
              "total_pages": {
                "type": "integer"
              }
            }
          }
        }
      },
      "commands": {
        "mode": "inspect",
        "cli": "telipot inspect apollo.people.contacts.search",
        "http": "curl https://api.telipot.com/v1/tasks/apollo.people.contacts.search \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\""
      },
      "siblings": []
    }
  ]
}