Skip to main content
GET
/
vacancies
Get vacancies with cursor pagination
curl --request GET \
  --url https://api.gospott.com/vacancies \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "client": {
        "viewType": "vacancyClient",
        "client": {
          "industry": "Accessible Architecture and Design",
          "size": "1 employee",
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "domain": "<string>",
          "logoUrl": "<string>"
        }
      },
      "name": {
        "viewType": "vacancyName",
        "name": "<string>"
      },
      "description": {
        "viewType": "vacancyDescription",
        "description": "<string>"
      },
      "status": {
        "status": "open",
        "viewType": "vacancyStatus"
      },
      "createdAt": {
        "viewType": "vacancyCreatedAt",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "startAt": {
        "viewType": "vacancyStartAt",
        "startAt": "2023-11-07T05:31:56Z"
      },
      "endAt": {
        "viewType": "vacancyEndAt",
        "endAt": "2023-11-07T05:31:56Z"
      },
      "salaryRange": {
        "viewType": "vacancySalaryRange",
        "salaryRange": {
          "currency": "USD",
          "min": 123,
          "max": 123
        }
      },
      "location": {
        "viewType": "vacancyLocation",
        "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": {
        "viewType": "vacancyTeam",
        "team": [
          {
            "userId": "<string>",
            "name": "<string>",
            "email": "<string>",
            "avatarUrl": "<string>",
            "deactivatedAt": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "employmentType": {
        "employmentType": "fullTime",
        "viewType": "vacancyEmploymentType"
      },
      "locationType": {
        "locationType": "remote",
        "viewType": "vacancyLocationType"
      },
      "clientTeam": {
        "viewType": "<string>",
        "clientTeam": [
          {
            "id": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "middleName": "<string>",
            "secondLastName": "<string>",
            "avatarUrl": "<string>",
            "candidateId": "<string>",
            "companyId": "<string>",
            "companyName": "<string>",
            "companyLogoUrl": "<string>"
          }
        ]
      },
      "scorecard": {
        "viewType": "vacancyScorecard",
        "scorecards": [
          {
            "group_name": "<string>",
            "attributes": [
              {
                "attribute": "<string>"
              }
            ]
          }
        ]
      },
      "nextTaskDue": {
        "viewType": "vacancyNextTaskDue",
        "nextTaskDue": {
          "id": "<string>",
          "content": "<string>",
          "dueDate": "2023-11-07T05:31:56Z"
        }
      }
    }
  ],
  "pageInfo": {}
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
limit
number

Maximum number of vacancies to return per page. Must be between 1 and 50. Defaults to 25.

Required range: 1 <= x <= 50
Example:

25

​
modifiedSince
string<date-time>

ISO 8601 datetime string to filter vacancies modified on or after this date. Useful for incremental syncing to get only updated records. If omitted, returns all vacancies from the beginning of time.

Example:

"2024-01-01T00:00:00.000Z"

​
cursor
string<date-time>

ISO 8601 datetime cursor for pagination. Use the nextCursor value from the previous response to fetch the next page. Represents the modifiedAt timestamp to start from. Omit for the first page.

Example:

"2024-01-15T10:30:00.000Z"

Response

Successfully retrieved vacancies. Returns items array with VacancyBaseDto objects and pagination info containing cursor for the next page.

​
items
object[]
required
​
pageInfo
object
required