The API is being built domain by domain. The reference shows what exists today.
Skip to Content
KITHDocs
ReferenceObjects

Search

A search: one conversation with Kith about one role, holding its brief, the people Kith found and the decisions on them. A search belongs to the whole workspace.

type Search {
  archiveVersion: Int!
  archivedAt: DateTime
  briefRevision: Int!
  candidateCount: Int!
  client: SearchClient
  company: String!
  depth: SearchDepth
  id: ID!
  lastMessage: String!
  lastMessageAt: DateTime
  location: String!
  origin: SearchOrigin
  peopleToReview: Int!
  seenVersion: Int!
  status: SearchStatus!
  title: String!
  updatedAt: DateTime!
}

Fields

Search.archiveVersion · Int! non-null scalar

Increases each time the search is archived or restored, so a caller holding two answers can tell which is newer.

Search.archivedAt · DateTime scalar

When the workspace archived the search. Null for one it has not. Archiving hides a search from everyday lists and changes nothing else about it.

Search.briefRevision · Int! non-null scalar

The number of the brief's current revision. 0 until Kith has read the brief.

Search.candidateCount · Int! non-null scalar

How many people Kith has delivered in the search so far.

Search.client · SearchClient object

The client the search is for, when one is set.

Search.company · String! non-null scalar

The hiring company, as the brief names it.

Search.depth · SearchDepth enum

How deep the search goes.

Search.id · ID! non-null scalar

The search's id, as in its URL in the app.

Search.lastMessage · String! non-null scalar

The text of the latest message in the search.

Search.lastMessageAt · DateTime scalar

When the latest message was sent. Searches are listed by it, newest first.

Search.location · String! non-null scalar

Where the role is based, as the brief says it.

Search.origin · SearchOrigin object

The site the search was opened from. Null for a search opened in Kith.

Search.peopleToReview · Int! non-null scalar

How many people in the search's delivered shortlists the caller has not seen yet. Counted for each member separately.

Search.seenVersion · Int! non-null scalar

Orders the caller's own marks of what they have seen: the latest mark peopleToReview takes in. A count with a lower version was read before a later mark. 0 before any mark.

Search.status · SearchStatus! non-null enum

Where the search stands.

Search.title · String! non-null scalar

The search's name: the role and company once Kith has read the brief, a working title before.

Search.updatedAt · DateTime! non-null scalar

When anything about the search last changed.

Member Of

SearchEdge object

On this page

FieldsSearch.archiveVersion · Int! non-null scalarSearch.archivedAt · DateTime scalarSearch.briefRevision · Int! non-null scalarSearch.candidateCount · Int! non-null scalarSearch.client · SearchClient objectSearch.company · String! non-null scalarSearch.depth · SearchDepth enumSearch.id · ID! non-null scalarSearch.lastMessage · String! non-null scalarSearch.lastMessageAt · DateTime scalarSearch.location · String! non-null scalarSearch.origin · SearchOrigin objectSearch.peopleToReview · Int! non-null scalarSearch.seenVersion · Int! non-null scalarSearch.status · SearchStatus! non-null enumSearch.title · String! non-null scalarSearch.updatedAt · DateTime! non-null scalarMember Of