Operations

Search Jointl

Quickly search the connected workspace across authorized people, emails, attributes, companies, tags, job titles, and Flows using the same permissions and relevance ranking as the Jointl UI. An optional source-type filter is applied before ranking. Returns at most 30 top matches and is not an exhaustive list.

Use when: Use for quick entity lookup from a name, email, attribute, company, tag, job title, or Flow phrase; optionally restrict source types before ranking, and use a domain list or analytics operation for complete cohorts. Returns: ranked matches in sourceRecords, suggested next operations in followUpOperations, result counts, the applied limit, and exhaustive: false.

POST

https://api.join.tl

api

operations

workspace.search

Search Jointl

curl --request POST \
  --url https://api.join.tl/api/v1/operations/workspace.search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Ada Example"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'Ada Example'})
};

fetch('https://api.join.tl/api/v1/operations/workspace.search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.join.tl/api/v1/operations/workspace.search"

payload = { "query": "Ada Example" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "exhaustive": false,
    "items": [
      {
        "entityId": "applicant_example_01",
        "entityType": "applicant",
        "followUpOperations": [
          {
            "input": {
              "applicantId": "applicant_example_01",
              "includeEvidence": true
            },
            "operationId": "checks.get"
          }
        ],
        "label": "Ada Example",
        "sourceRecords": [
          {
            "applicantId": "applicant_example_01",
            "companyName": "Example Company",
            "entityId": "applicant_example_01",
            "entityType": "applicant",
            "label": "Applicant",
            "primary": "Software Engineer",
            "route": "/checks/applicant_example_01",
            "statusLabels": [
              {
                "className": "new",
                "label": "New",
                "value": "new"
              }
            ]
          }
        ]
      }
    ],
    "query": "Ada Example",
    "resultLimit": 30,
    "returnedCount": 1
  },
  "requestId": "request_example_01"
}

{
  "error": {
    "code": "invalid-external-operation-input",
    "message": "The operation input is invalid."
  },
  "requestId": "request_example_400"
}

{
  "error": {
    "code": "not-authenticated",
    "message": "Authentication is required."
  },
  "requestId": "request_example_401"
}

{
  "error": {
    "code": "not-authorized",
    "message": "You are not allowed to perform this action."
  },
  "requestId": "request_example_403"
}

{
  "error": {
    "code": "not-found",
    "message": "The requested record was not found."
  },
  "requestId": "request_example_404"
}

{
  "error": {
    "code": "external-action-conflict",
    "message": "The action conflicts with current state."
  },
  "requestId": "request_example_409"
}

{
  "error": {
    "code": "request-too-large",
    "message": "The request body is too large."
  },
  "requestId": "request_example_413"
}

{
  "error": {
    "code": "too-many-requests",
    "message": "Too many requests."
  },
  "requestId": "request_example_429"
}

{
  "error": {
    "code": "internal-error",
    "message": "The request could not be completed."
  },
  "requestId": "request_example_500"
}

{
  "error": {
    "code": "temporarily-unavailable",
    "message": "The service is temporarily unavailable."
  },
  "requestId": "request_example_503"
}

Authorizations

Authorization

string

header

required

OAuth access token issued for the REST resource.

Body

application/json

query

string

required

Search people, emails, attributes, companies, tags, job titles, and Flows.

Required string length: 2 - 120

entityTypes

enum<string>[]

Optional source-type filter applied before ranking. Omit it to search every global-search type.

Required array length: 1 - 6 elements

Available options:

applicant,

employee,

talent,

reference,

flow,

member

limit

integer

default:30

Required range: 1 <= x <= 30

Response

Operation completed.

data

object

required

Show child attributes

requestId

string

required

Request correlation identifier.

⌘I

Search Jointl

curl --request POST \
  --url https://api.join.tl/api/v1/operations/workspace.search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Ada Example"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'Ada Example'})
};

fetch('https://api.join.tl/api/v1/operations/workspace.search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.join.tl/api/v1/operations/workspace.search"

payload = { "query": "Ada Example" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "exhaustive": false,
    "items": [
      {
        "entityId": "applicant_example_01",
        "entityType": "applicant",
        "followUpOperations": [
          {
            "input": {
              "applicantId": "applicant_example_01",
              "includeEvidence": true
            },
            "operationId": "checks.get"
          }
        ],
        "label": "Ada Example",
        "sourceRecords": [
          {
            "applicantId": "applicant_example_01",
            "companyName": "Example Company",
            "entityId": "applicant_example_01",
            "entityType": "applicant",
            "label": "Applicant",
            "primary": "Software Engineer",
            "route": "/checks/applicant_example_01",
            "statusLabels": [
              {
                "className": "new",
                "label": "New",
                "value": "new"
              }
            ]
          }
        ]
      }
    ],
    "query": "Ada Example",
    "resultLimit": 30,
    "returnedCount": 1
  },
  "requestId": "request_example_01"
}

{
  "error": {
    "code": "invalid-external-operation-input",
    "message": "The operation input is invalid."
  },
  "requestId": "request_example_400"
}

{
  "error": {
    "code": "not-authenticated",
    "message": "Authentication is required."
  },
  "requestId": "request_example_401"
}

{
  "error": {
    "code": "not-authorized",
    "message": "You are not allowed to perform this action."
  },
  "requestId": "request_example_403"
}

{
  "error": {
    "code": "not-found",
    "message": "The requested record was not found."
  },
  "requestId": "request_example_404"
}

{
  "error": {
    "code": "external-action-conflict",
    "message": "The action conflicts with current state."
  },
  "requestId": "request_example_409"
}

{
  "error": {
    "code": "request-too-large",
    "message": "The request body is too large."
  },
  "requestId": "request_example_413"
}

{
  "error": {
    "code": "too-many-requests",
    "message": "Too many requests."
  },
  "requestId": "request_example_429"
}

{
  "error": {
    "code": "internal-error",
    "message": "The request could not be completed."
  },
  "requestId": "request_example_500"
}

{
  "error": {
    "code": "temporarily-unavailable",
    "message": "The service is temporarily unavailable."
  },
  "requestId": "request_example_503"
}

Jointl REST API and OAuth

Greenhouse integration

Zapier event delivery

Search Jointl

Authorizations

Body

Response