logo-darkPipe0

Check search run

Check status of search task. Poll this endpoint to until the status becomes 'completed'. Recommended polling intervals are between 1-3s.

GET
/v1/search/check/{run_id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

run_id*|

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.pipe0.com/v1/search/check/xyz"
{
  "id": "string",
  "status": "completed",
  "search_id": "companies:profiles:crustdata@1",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "path": "string"
    }
  ],
  "results": [
    {
      "property1": {
        "value": "string",
        "status": "completed",
        "type": "string",
        "format": "json_object",
        "resolved_by": {
          "ref": "prompt:run@1",
          "environment": "production",
          "config_hash": "string",
          "input_hash": "string"
        },
        "widgets": {
          "display_value": {
            "label": "string"
          },
          "entity_logo": {
            "image_url": "http://example.com",
            "entity": "string"
          },
          "location_indicator": {
            "emoji": "string"
          },
          "avatar": {
            "image_url": "http://example.com",
            "name": "string"
          },
          "waterfall": {
            "attempted_providers": [
              {
                "provider": "pipe0"
              }
            ],
            "available_providers": [
              "pipe0"
            ],
            "successful_provider": "pipe0"
          },
          "icon": {
            "key": "linkedin"
          },
          "action_summary": {
            "result_status": "completed"
          },
          "sources": {
            "list": [
              {
                "source": "string",
                "description": "string",
                "url": "string"
              }
            ]
          },
          "confidence": {
            "numeric": 1
          }
        }
      },
      "property2": {
        "value": "string",
        "status": "completed",
        "type": "string",
        "format": "json_object",
        "resolved_by": {
          "ref": "prompt:run@1",
          "environment": "production",
          "config_hash": "string",
          "input_hash": "string"
        },
        "widgets": {
          "display_value": {
            "label": "string"
          },
          "entity_logo": {
            "image_url": "http://example.com",
            "entity": "string"
          },
          "location_indicator": {
            "emoji": "string"
          },
          "avatar": {
            "image_url": "http://example.com",
            "name": "string"
          },
          "waterfall": {
            "attempted_providers": [
              {
                "provider": "pipe0"
              }
            ],
            "available_providers": [
              "pipe0"
            ],
            "successful_provider": "pipe0"
          },
          "icon": {
            "key": "linkedin"
          },
          "action_summary": {
            "result_status": "completed"
          },
          "sources": {
            "list": [
              {
                "source": "string",
                "description": "string",
                "url": "string"
              }
            ]
          },
          "confidence": {
            "numeric": 1
          }
        }
      }
    }
  ],
  "organization_id": "string",
  "next_page": {
    "search_id": "people:profiles:crustdata@1",
    "connector": {
      "strategy": "first",
      "connections": [
        {
          "type": "vault",
          "connection": "string"
        }
      ]
    },
    "config": {
      "pagination": {
        "limit": 100,
        "cursor": null
      },
      "output_fields": {
        "name": {
          "alias": "",
          "enabled": true
        },
        "company_website_url": {
          "alias": "",
          "enabled": true
        },
        "profile_url": {
          "alias": "",
          "enabled": true
        },
        "job_title": {
          "alias": "",
          "enabled": true
        },
        "crustdata_person_match": {
          "alias": "",
          "enabled": true
        }
      },
      "filters": {
        "locations": {
          "include": [],
          "exclude": []
        },
        "profile_headline_keywords": {
          "include": [],
          "exclude": []
        },
        "profile_summary_keywords": {
          "include": [],
          "exclude": []
        },
        "profile_languages": {
          "include": [],
          "exclude": []
        },
        "languages": {
          "include": [],
          "exclude": []
        },
        "skills": {
          "include": [],
          "exclude": []
        },
        "years_of_experience": [
          "Less than 1 year"
        ],
        "current_seniority_levels": {
          "include": [],
          "exclude": []
        },
        "current_employers": {
          "include": [],
          "exclude": []
        },
        "current_employers_website_urls": {
          "include": [],
          "exclude": []
        },
        "current_job_titles": {
          "include": [],
          "exclude": []
        },
        "current_employers_linkedin_industries": {
          "include": [],
          "exclude": []
        },
        "years_at_current_company": [
          "Less than 1 year"
        ],
        "previous_employers_website_urls": {
          "include": [],
          "exclude": []
        },
        "previous_seniority_levels": {
          "include": [],
          "exclude": []
        },
        "previous_employers": {
          "include": [],
          "exclude": []
        },
        "previous_job_titles": {
          "include": [],
          "exclude": []
        },
        "previous_employers_linkedin_industries": {
          "include": [],
          "exclude": []
        },
        "certifications": {
          "include": [],
          "exclude": []
        },
        "honors": {
          "include": [],
          "exclude": []
        },
        "recently_changed_jobs": null,
        "fields_of_study": {
          "include": [],
          "exclude": []
        },
        "degree_names": {
          "include": [],
          "exclude": []
        },
        "school_names": {
          "include": [],
          "exclude": []
        },
        "current_school_names": {
          "include": [],
          "exclude": []
        },
        "extracurricular_activities": {
          "include": [],
          "exclude": []
        }
      }
    }
  },
  "pagination_type": "cursor",
  "total_pages": 0
}
{
  "type": "invalid-input",
  "title": "Invalid Input",
  "status": 400,
  "detail": "Name must be a string"
}
{
  "type": "invalid-input",
  "title": "Invalid Input",
  "status": 400,
  "detail": "Name must be a string"
}
{
  "type": "invalid-input",
  "title": "Invalid Input",
  "status": 400,
  "detail": "Name must be a string"
}
{
  "type": "invalid-input",
  "title": "Invalid Input",
  "status": 400,
  "detail": "Name must be a string"
}