Skip to main content
POST
/
vacancies
/
_search
Search jobs
curl --request POST \
  --url https://api.gospott.com/vacancies/_search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filters": [
    {
      "type": "text",
      "operator": "contains",
      "path": "vacancy.name",
      "value": "<string>"
    }
  ],
  "page": 0,
  "pageSize": 20
}
'
{
  "items": [
    {
      "employmentType": "fullTime",
      "locationType": "remote",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "stage": {
        "id": "<string>",
        "order": 123,
        "name": "<string>",
        "colorHex": "<string>",
        "isOpen": true
      },
      "client": {
        "industry": "Accessible Architecture and Design",
        "size": "1 employee",
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "domain": "<string>",
        "logoUrl": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "startAt": "2023-11-07T05:31:56Z",
      "endAt": "2023-11-07T05:31:56Z",
      "salaryRange": {
        "currency": "AED",
        "min": 123,
        "max": 123
      },
      "location": {
        "type": "primary_home",
        "street1": "<string>",
        "street2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "region": "<string>",
        "state": "<string>",
        "country": "<string>",
        "rawCityCountry": "<string>",
        "latitude": 123,
        "longitude": 123,
        "formattedAddress": "<string>"
      },
      "team": [
        {
          "userId": "<string>",
          "name": "<string>",
          "email": "jsmith@example.com",
          "avatarUrl": "<string>",
          "deactivatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "clientTeam": [
        {
          "id": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "middleName": "<string>",
          "secondLastName": "<string>",
          "avatarUrl": "<string>",
          "candidateId": "<string>",
          "companyId": "<string>",
          "companyName": "<string>",
          "companyLogoUrl": "<string>",
          "jobTitle": "<string>",
          "department": "<string>",
          "emails": [
            {
              "purpose": "personal",
              "email": "jsmith@example.com",
              "isPrimary": true
            }
          ],
          "phoneNumbers": [
            {
              "purpose": "personal",
              "phoneNumber": "<string>",
              "isPrimary": true
            }
          ]
        }
      ],
      "scorecard": [
        {
          "groupName": "<string>",
          "attributes": [
            {
              "attribute": "<string>"
            }
          ]
        }
      ],
      "nextTaskDue": {
        "id": "<string>",
        "content": "<string>",
        "dueDate": "2023-11-07T05:31:56Z"
      },
      "customAttributes": [
        {
          "value": {
            "viewType": "customText",
            "text": "<string>"
          },
          "attributeDefinitionId": "<string>",
          "label": "<string>",
          "aiFillOngoing": true,
          "aiOverridden": true,
          "isFilledByAI": true
        }
      ]
    }
  ],
  "pagination": {
    "hasNextPage": true
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
filters
object[]
page
integer
default:0
Required range: x >= 0
pageSize
integer
default:20
Required range: 1 <= x <= 100

Response

Successfully searched jobs

items
object[]
required
pagination
object
required