Skip to main content Link Search Menu Expand Document (external link)

Updated Mon Nov 28th 2022, 17:50 UTC

3rd-Party Contact Search

POST /:account/integrations/contact_search{?provider,q}

If searching for a Contact within TextUs provides no results, a User may want to search for contacts within any integrated ATS or CMS applications that have been configured. This endpoint provides a common interface to the various Integrations that support searching, and also maps the results into the Contact type.

Examples

Searching Bullhorn Candidates

Request

POST /my_account/integrations/contact_search?provider=bullhorn&q=3035551000
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/integrations/contact_search?provider=bullhorn&q=3035551000
    

Response

Status

200

Response Type

hydra:Collection

Example Body

{
  "@context": "/contexts/hydra:Collection.jsonld",
  "@type": "hydra:Collection",
  "id": "/my_account/integrations/contact_search?provider=bullhorn&q=3035551000",
  "members": [
    {
      "@context": "/contexts/Contact.jsonld",
      "@type": "Contact",
      "id": "/contacts/bullhorn-Candidate-1",
      "firstName": "Chuck",
      "lastName": "Norris",
      "name": "Chuck Norris",
      "data": {
        "bullhorn": {
          "Candidate": {
            "companyName": "Texas Rangers",
            "email": "chuck@rangers.example",
            "firstName": "Chuck",
            "id": 42,
            "lastName": "Norris",
            "mobile": null,
            "name": "Chuck Norris",
            "phone": "3035551000",
            "phone2": null,
            "phone3": null,
            "status": "Active",
            "workPhone": null
          }
        }
      },
      "customData": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/contacts/bullhorn-Candidate-226/custom_data",
        "members": [
          {
            "@type": "ContactData",
            "@context": "/contexts/ContactData.jsonld",
            "id": "/contacts/bullhorn-Candidate-226/custom_data/bullhorn/Candidate",
            "contactSchema": {
              "@type": "ContactSchema",
              "@context": "/contexts/ContactSchema.jsonld",
              "id": "/my_account/contact_schemas/bullhorn/Candidate",
              "slug": "bullhorn/Candidate",
              "title": "Bullhorn Candidate",
              "fields": "/my_account/contact_schemas/bullhorn/Candidate/fields"
            },
            "data": [
              {
                "customField": {
                  "@type": "ContactField",
                  "@context": "/contexts/ContactField.jsonld",
                  "id": "/my_account/contact_schemas/contact/bullhorn/Candidate/id",
                  "slug": "id",
                  "title": "ID",
                  "type": "integer",
                  "description": "Bullhorn ID",
                  "externalId": true,
                  "externalLink": false,
                  "displayOrder": null
                },
                "value": 42
              },
              {
                "customField": {
                  "@type": "ContactField",
                  "@context": "/contexts/ContactField.jsonld",
                  "id": "/my_account/contact_schemas/contact/bullhorn/Candidate/link",
                  "slug": "link",
                  "title": "Link",
                  "type": "url",
                  "description": "Bullhorn Link",
                  "externalId": false,
                  "externalLink": true,
                  "displayOrder": null
                },
                "value": null
              },
              {
                "customField": {
                  "@type": "ContactField",
                  "@context": "/contexts/ContactField.jsonld",
                  "id": "/my_account/contact_schemas/contact/bullhorn/Candidate/name",
                  "slug": "name",
                  "title": "Name",
                  "type": "text",
                  "description": null,
                  "externalId": false,
                  "externalLink": false,
                  "displayOrder": 10
                },
                "value": "Chuck Norris"
              }
            ]
          }
        ],
        "totalItems": 1
      },
      "notes": {
        "@context": "/contexts/hydra:Collection.jsonld",
        "@type": "hydra:Collection",
        "id": "/contacts/bullhorn-Candidate-1/notes",
        "members": [],
        "totalItems": 0
      },
      "phones": {
        "@context": "/contexts/hydra:Collection.jsonld",
        "@type": "hydra:Collection",
        "id": "/contacts/bullhorn-Candidate-1/phones",
        "members": [
          {
            "@context": "/contexts/ContactPhone.jsonld",
            "@type": "ContactPhone",
            "contact": "/contacts/AlQX1N",
            "deliverabilityStatus": null,
            "extension": null,
            "formattedPhoneNumber": "(303) 555-1000",
            "id": "/contact_phones/bullhorn-Candidate-Phone-phone",
            "phoneNumber": "+13035551000",
            "type": "phone"
          }
        ],
        "totalItems": 1
      },
      "createdAt": null,
      "conversations": "/contacts/bullhorn-Candidate-1/conversations"
    }
  ],
  "totalItems": 1
}

© 2022 TextUs