Skip to main content
GET
/
applications
/
vacancy
/
{vacancyId}
Get applications by vacancy
curl --request GET \
  --url https://api.gospott.com/applications/vacancy/{vacancyId} \
  --header 'x-api-key: <api-key>'
{
  "vacancy": {
    "stageTotals": {
      "viewType": "vacancyStageTotals",
      "totals": [
        {
          "type": "speculative",
          "id": "<string>",
          "name": "<string>",
          "order": 123,
          "total": 123
        }
      ]
    },
    "customAttributes": [
      {
        "value": "<any>",
        "attributeDefinitionId": "<string>",
        "label": "<string>",
        "description": "<string>",
        "filledByAI": true,
        "options": [
          "<string>"
        ]
      }
    ],
    "clientPortalId": "<string>",
    "lastRankedAt": "2023-11-07T05:31:56Z",
    "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"
      }
    }
  },
  "applications": [
    {
      "latestActivity": {
        "type": "appliedInbound",
        "date": "2023-11-07T05:31:56Z",
        "triggeredByUserId": "<string>",
        "triggeredByUserName": "<string>"
      },
      "id": "<string>",
      "stage": {
        "type": "speculative",
        "templateType": "DEFAULT_SPECULATIVE",
        "viewType": "applicationStage",
        "id": "<string>",
        "name": "<string>",
        "order": 123,
        "status": {
          "id": "<string>",
          "name": "<string>",
          "colorHex": "<string>"
        },
        "colorHex": "<string>",
        "templateId": "<string>"
      },
      "owner": {
        "viewType": "applicationOwner",
        "owner": {
          "id": "<string>",
          "name": "<string>",
          "avatarUrl": "<string>",
          "deactivatedAt": "2023-11-07T05:31:56Z"
        }
      },
      "candidate": {
        "viewType": "applicationCandidate",
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatarUrl": "<string>",
        "emails": [
          "<string>"
        ],
        "lastWorkExperience": {
          "companySize": "1 employee",
          "id": "<string>",
          "companyName": "<string>",
          "companyId": "<string>",
          "jobTitle": "<string>",
          "description": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "endDate": "2023-11-07T05:31:56Z"
        },
        "lastActivityAt": "2023-11-07T05:31:56Z"
      },
      "isPlaced": true,
      "applicationState": {
        "state": "for-review",
        "viewType": "<string>"
      },
      "noteCount": 123,
      "commentCount": 123,
      "uncompletedTaskCount": 123,
      "nextInterview": {
        "id": "<string>",
        "startTime": "2023-11-07T05:31:56Z",
        "endTime": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "meetingId": "<string>"
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

vacancyId
string
required

Response

Successfully retrieved applications. Returns the vacancy and all applications associated with it.

vacancy
object
required
applications
object[]
required