List positions | Vouch | Documentation

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "pitch": "string",
      "status": "DRAFT",
      "language": "NO",
      "employmentType": [
        "Full-time"
      ],
      "listingColor": "string",
      "bannerUrl": "string",
      "locations": [
        {
          "id": "string",
          "address": "string",
          "city": "string",
          "country": "string",
          "locality": "string",
          "postalCode": "string",
          "administrativeArea": "string",
          "subAdministrativeArea": "string",
          "lat": 1.1,
          "lng": 1.1
        }
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "publishedAt": "2024-01-15T09:30:00Z",
      "lastPublishedAt": "2024-01-15T09:30:00Z",
      "firstActivatedAt": "2024-01-15T09:30:00Z",
      "expirationDate": "2024-01-15T09:30:00Z",
      "enableApplication": true,
      "enableVouch": true,
      "company": {
        "name": "string",
        "logoUrl": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Authentication

AuthorizationBearer

API key created in company settings, sent as Authorization: Bearer <key>.

Query parameters

clientIdstringOptional

Filter to positions managed on behalf of this client (an agency’s sub-company). Mutually exclusive with clientSlug — if both are given, clientId wins. Returns 400 if it doesn’t match a client of this company.

clientSlugstringOptional

Same as clientId, but by the client's slug instead of its ID.

statusenumOptional

Filter to positions with this publish status. See Position.status.

Allowed values:

takeintegerOptional1-100Defaults to 50

Page size, max 100 (default 50).

cursorstringOptional

Position ID to resume pagination from (from a previous nextCursor).

Response

Positions the API key can access.

datalist of objects

nextCursorstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error