> ## Documentation Index > Fetch the complete documentation index at: https://docs.jobin.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Search people > Find new people using recruiting criteria and save the results to Jobin Contacts. Find people using company, role, location, or similar-profile criteria. Each returned person is saved to Jobin Contacts. Use their `contactId` to review the saved record. ## Before you search This action requires Scale or an eligible enterprise workspace. Each returned person costs 20 Jobin credits. Jobin reserves credits for your requested result limit, then charges for the people returned. Email and phone availability depends on your workspace's access. Use [contact enrichment](/api-reference/contacts/trigger-enrichment) when you need additional contact information. ## Set your criteria Use the structured `company`, `people`, `locations`, and `similarTo` fields. For a search around a city, use `radiusAroundCity`. `limit` defaults to 10 and accepts up to 20 people per request. Preferences rank results within each returned page. ## Continue through results For the next page, pass `nextCursor` from the response as `cursor`. Keep the same filters and limit. Leave out `cursor` on your first request. Each additional page is a new paid search. *Rate limit: 10 requests/minute per endpoint and workgroup. [Details](/development#rate-limits).* ## OpenAPI ````yaml openapi/jobin-integration.json POST /people/search openapi: 3.1.0 info: title: Jobin Integration API version: 1.0.0 description: >- Work with Jobin contacts and outreach sequences from your recruiting tools and AI assistants. See [integration guidelines](https://docs.jobin.cloud/development#rate-limits) for rate limits and retries. servers: - url: https://my.jobin.cloud/api/openapi/v1 description: Public OpenAPI base URL. Append each path below to this base URL. security: [] paths: /people/search: post: summary: Search people description: >- Paid people search using known profile data and a broad people index. Requires the Scale plan or an eligible enterprise workspace. Each returned person costs 20 Jobin credits and is saved to Jobin Contacts; contactId identifies the saved contact. Jobin reserves credits for the requested limit and settles the charge against the returned count. Every cursor page is a new paid invocation. Available email and phone fields depend on workspace entitlement. Use contact enrichment to request additional contact data. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PeopleSearchRequest' responses: '200': description: People search results. content: application/json: schema: $ref: '#/components/schemas/PeopleSearchResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimitExceeded' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/ApiError' security: - ApiKeyAuth: [] components: schemas: PeopleSearchRequest: type: object properties: company: description: >- Company filters for broad company matching and known profile evidence. type: object properties: linkedin_url: $ref: '#/components/schemas/PeopleSearchStringList' description: Exact company profile URLs. name: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Company name keyword filter. currentCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Current company name filter. previousCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Previous company name filter. industry: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Company industry filter. type: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Company type filter. employee_range: $ref: '#/components/schemas/PeopleSearchStringList' description: Employee ranges, such as 1-10, 11-50, 51-200, 10001+. employee_count: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Employee count range. min_linkedin_followers: description: Minimum profile follower count. type: number revenue: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Revenue range. naics_code: $ref: '#/components/schemas/PeopleSearchValueFilter' description: NAICS code filter. sic_code: $ref: '#/components/schemas/PeopleSearchValueFilter' description: SIC code filter. web_traffic: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Monthly web traffic range. ad_spend: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Monthly Google ad spend range in USD. total_funding: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Total funding range in USD. last_funding_amount: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Last funding round amount range in USD. last_funding_year: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Last funding round year range. last_funding_type: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Last funding type filter. lead_investors: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Lead investor keyword filter. keywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Company description, specialty, category, and keyword filter. founded_year: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Company founded year range. hq: description: Company headquarters filters. type: object properties: city: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Headquarters city filter. state: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Headquarters state or province filter. country_code: $ref: '#/components/schemas/PeopleSearchStringList' description: Headquarters country codes, for example US, GB, FR. continent: $ref: '#/components/schemas/PeopleSearchStringList' description: Headquarters continents. sales_region: $ref: '#/components/schemas/PeopleSearchStringList' description: Headquarters sales regions such as NORAM, LATAM, EMEA, APAC. additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' people: description: >- People filters. Rich evidence filters are verified against known profile data. type: object properties: name: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Full-name keyword filter. firstName: $ref: '#/components/schemas/PeopleSearchValueFilter' description: First-name keyword filter. lastName: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Last-name keyword filter. profileUrl: description: Exact person profile URL. type: string minLength: 3 maxLength: 2048 socialUrl: description: Alias for profileUrl. type: string minLength: 3 maxLength: 2048 job_title: $ref: '#/components/schemas/PeopleSearchJobTitleFilter' description: Current job title filter. title: $ref: '#/components/schemas/PeopleSearchJobTitleFilter' description: Alias for current job title filter. job_function: $ref: '#/components/schemas/PeopleSearchStringList' description: Current job function values. job_level: $ref: '#/components/schemas/PeopleSearchStringList' description: >- Current job levels such as C-Team, VP, Director, Manager, Staff, Other. min_connections: description: Minimum profile connections. type: number minimum: 0 maximum: 500 locations: description: >- Person location filters. Each market has its own city, region, and country; radiusAroundCity resolves the in-radius locality catchment. maxItems: 25 type: array items: $ref: '#/components/schemas/PeopleSearchLocation' currentCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Current company filter. previousCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Previous company filter. tenure: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Years in the current role or company. yearsAtCurrentCompany: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Alias for tenure at the current company. totalYearsExperience: $ref: '#/components/schemas/PeopleSearchNumberRange' description: Total years of professional experience. skills: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Skills listed on known profiles. education: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Education phrase, school, degree, or field filter. degree: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Academic credential level filter, such as MBA, MSc, Bachelor, Master, or PhD. fieldOfStudy represents majors or subjects such as Civil Engineering. school: $ref: '#/components/schemas/PeopleSearchValueFilter' description: School or university filter. fieldOfStudy: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Field of study, major, or minor filter, such as Civil Engineering, Structural Engineering, or Computer Science. jobDescriptionKeywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Keywords in job descriptions and responsibilities. summaryKeywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Keywords in profile summary, about text, or accomplishments. matchGroups: description: >- Alternative criteria groups. At least one group matches; criteria within a group are conjunctive. maxItems: 10 type: array items: type: object properties: name: description: Optional client-provided label for this match group. type: string minLength: 1 maxLength: 200 operator: description: >- Requires at least one group alternative to match. Fields inside one group alternative are AND-ed. default: must_match_one_group type: string const: must_match_one_group groups: description: >- Alternative criteria entries. Supply synonym and expansion alternatives as separate criteria. minItems: 1 maxItems: 20 type: array items: type: object properties: title: $ref: '#/components/schemas/PeopleSearchJobTitleFilter' description: Title evidence for this match-group alternative. job_title: $ref: '#/components/schemas/PeopleSearchJobTitleFilter' description: >- Alias for title evidence in this match-group alternative. skills: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Skill evidence for this match-group alternative. jobDescriptionKeywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Job-description evidence for this match-group alternative. summaryKeywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Profile-summary evidence for this match-group alternative. education: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Education evidence for this match-group alternative. degree: $ref: '#/components/schemas/PeopleSearchValueFilter' description: Degree evidence for this match-group alternative. school: $ref: '#/components/schemas/PeopleSearchValueFilter' description: School evidence for this match-group alternative. fieldOfStudy: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Field-of-study evidence for this match-group alternative. currentCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Current-company evidence for this match-group alternative. previousCompany: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Previous-company evidence for this match-group alternative. company: description: Company evidence for this match-group alternative. type: object properties: industry: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Company industry evidence for this match-group alternative. keywords: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Company keyword evidence for this match-group alternative. name: $ref: '#/components/schemas/PeopleSearchValueFilter' description: >- Company name evidence for this match-group alternative. additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' anyOf: - required: - title properties: title: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - job_title properties: job_title: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - skills properties: skills: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - jobDescriptionKeywords properties: jobDescriptionKeywords: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - summaryKeywords properties: summaryKeywords: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - education properties: education: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - degree properties: degree: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - school properties: school: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - fieldOfStudy properties: fieldOfStudy: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - currentCompany properties: currentCompany: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - previousCompany properties: previousCompany: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - company properties: company: required: - industry properties: industry: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - company properties: company: required: - keywords properties: keywords: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 - required: - company properties: company: required: - name properties: name: anyOf: - required: - include properties: include: minItems: 1 - required: - preferred properties: preferred: minItems: 1 - required: - exclude properties: exclude: minItems: 1 description: >- Each alternative must contain at least one supported criterion with a nonempty include, preferred, or exclude list. required: - groups additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' locations: description: >- Top-level person location filters. Each market has its own city, region, and country; radiusAroundCity resolves the in-radius locality catchment. maxItems: 25 type: array items: $ref: '#/components/schemas/PeopleSearchLocation' similarTo: description: Find more people like a supplied profile or example candidate. type: object properties: profileUrl: description: Profile URL to use as an example. type: string minLength: 3 maxLength: 2048 profileId: description: Known profile id to use as an example. type: string minLength: 3 maxLength: 64 exampleCandidate: description: Example candidate details to search for similar people. type: object properties: name: description: Example candidate name. type: string minLength: 1 maxLength: 200 profileUrl: description: Example candidate profile URL. type: string minLength: 3 maxLength: 2048 title: description: Example candidate current or target title. type: string minLength: 1 maxLength: 200 currentCompany: description: Example candidate current company. type: string minLength: 1 maxLength: 200 previousCompany: description: Example candidate previous company. type: string minLength: 1 maxLength: 200 location: description: Example candidate location. type: string minLength: 1 maxLength: 300 skills: $ref: '#/components/schemas/PeopleSearchStringList' description: Example candidate skills. education: $ref: '#/components/schemas/PeopleSearchStringList' description: Example candidate schools, degrees, or fields of study. summary: description: Example candidate summary or job-fit description. type: string minLength: 1 maxLength: 4000 additionalProperties: false additionalProperties: false cursor: description: >- Opaque nextCursor returned by a previous People Search page. Reuse the same filters and limit when continuing. type: string maxLength: 512 limit: description: >- Maximum people to return. Defaults to 10; capped at 20. Each returned person costs 20 credits. default: 10 type: integer minimum: 1 maximum: 20 additionalProperties: false description: >- People search request. Filters combine known profile data for precision with a broad people index for scale. Maximum 20 results per paid request. Strings are trimmed before validation. PeopleSearchResponse: type: object description: One page of people search results. properties: items: type: array items: $ref: '#/components/schemas/PeopleSearchProfile' count: type: integer description: Number of results returned in this page. nextCursor: type: - string - 'null' description: >- Cursor for the next page, or null when no more results are available. totalResults: type: - integer - 'null' description: Total matching result count when available. searchStrategy: type: object description: Search execution and ranking information for the retrieved page. properties: rankingScope: type: string description: >- Explains that preference ranking applies to this retrieved page rather than the complete candidate dataset. appliedTiers: type: array items: type: string description: Search tiers applied to this request. usedRequiredOnlyFallback: type: boolean description: Whether matching used only required criteria. additionalProperties: true PeopleSearchStringList: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 512 PeopleSearchValueFilter: type: object properties: include: $ref: '#/components/schemas/PeopleSearchStringList' description: Required matching values. preferred: $ref: '#/components/schemas/PeopleSearchStringList' description: >- Optional ranking signals. Matches may still be returned without these values. exclude: $ref: '#/components/schemas/PeopleSearchStringList' description: Values that disqualify a match. additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' PeopleSearchNumberRange: type: object properties: min: description: Inclusive minimum value. type: number max: description: Inclusive maximum value. type: number additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' PeopleSearchJsonValue: anyOf: - type: 'null' - type: boolean - type: number - type: string maxLength: 4000 - maxItems: 100 type: array items: $ref: '#/components/schemas/PeopleSearchJsonValue' - type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' PeopleSearchJobTitleFilter: type: object properties: include_linkedin_headline: description: Also search headline text when matching job titles. type: boolean include: $ref: '#/components/schemas/PeopleSearchStringList' description: >- Job title keywords. Square brackets, such as [CEO], represent exact matching. preferred: $ref: '#/components/schemas/PeopleSearchStringList' description: >- Job title keywords that should improve ranking but must not be required. exclude: $ref: '#/components/schemas/PeopleSearchStringList' description: Job title keywords to exclude. additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' PeopleSearchLocation: type: object properties: city: $ref: '#/components/schemas/PeopleSearchStringList' description: Person cities. region: $ref: '#/components/schemas/PeopleSearchStringList' description: Person states, regions, or provinces. country_code: $ref: '#/components/schemas/PeopleSearchStringList' description: Person country codes, for example US, GB, FR. continent: $ref: '#/components/schemas/PeopleSearchStringList' description: Person continents. sales_region: $ref: '#/components/schemas/PeopleSearchStringList' description: Person sales regions such as NORAM, LATAM, EMEA, APAC. postalCode: description: ZIP or postal code near the person location. type: string minLength: 1 maxLength: 32 zipCode: description: ZIP code alias for postalCode. type: string minLength: 1 maxLength: 32 radiusKm: description: Search radius in kilometers, up to 250. type: number minimum: 1 maximum: 250 radiusAroundCity: description: Find people in locations within the requested radius of a city. type: object properties: city: description: City used as the radius center. type: string minLength: 1 maxLength: 200 region: description: Optional state, region, or province. type: string minLength: 1 maxLength: 200 countryCode: description: Optional ISO country code. type: string minLength: 2 maxLength: 3 radiusKm: description: Radius in kilometers around the city, up to 250. type: number minimum: 1 maximum: 250 required: - city - radiusKm additionalProperties: $ref: '#/components/schemas/PeopleSearchJsonValue' not: required: - coordinates description: >- Person location filters. Use radiusAroundCity for a city-centered radius search. PeopleSearchProfile: type: object description: >- Profile result saved to Jobin Contacts. contactId identifies the saved CRM contact; id is the known profile identifier. Contact channels are optional and depend on workspace entitlement. additionalProperties: true properties: id: type: string description: >- Known profile identifier. Use contactId to retrieve the saved CRM contact. firstName: type: - string - 'null' description: Person first name. lastName: type: - string - 'null' description: Person last name. workEmail: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. privateEmail: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. socialUrls: type: array description: Social and professional profile URLs found for the person. items: type: string currentTitle: type: - string - 'null' description: Current role title mapped from experience data. currentCompany: type: - string - 'null' description: Current company name mapped from experience data. currentCompanySocialUrl: type: - string - 'null' description: Current company profile URL when available. location: oneOf: - $ref: '#/components/schemas/Location' - type: 'null' description: Person location mapped from location data. headline: type: - string - 'null' description: Public profile headline or current title. summary: type: - string - 'null' description: Public profile summary/about text. skills: type: array description: Skills mapped from people search data. items: $ref: '#/components/schemas/Skill' education: type: array description: Education mapped from people search data. items: $ref: '#/components/schemas/Education' accomplishments: type: array description: Certifications or accomplishments mapped from people search data. items: $ref: '#/components/schemas/Accomplishment' createdAt: type: string format: date-time description: When the contact was created in Jobin. updatedAt: type: string format: date-time description: When the contact was last updated in Jobin. middleName: type: - string - 'null' description: Contact middle name. currentCompanyUrl: type: - string - 'null' description: Current company website URL when available. currentCompanyFrom: type: - string - 'null' format: date-time description: >- Start date of the contact's current main professional experience when available. currentCompanyTo: type: - string - 'null' format: date-time description: >- End date stored on the contact's current main professional experience when available. currentCompanyTenureYears: type: - number - 'null' description: Recorded current-company tenure in years. industry: type: - string - 'null' description: industry stored on the contact. openProfile: type: - boolean - 'null' description: if the profile is marked as open profile/open link. openToWork: type: - boolean - 'null' description: if the contact is marked as open to work. languages: type: array description: Languages attached to the contact. items: $ref: '#/components/schemas/Language' volunteering: type: array description: Volunteer experience attached to the contact. items: $ref: '#/components/schemas/VolunteerExperience' experiences: type: array description: >- Full professional work history for single-contact detail reads. Contact list responses stay compact and may omit this field. items: $ref: '#/components/schemas/ContactExperience' currentCompanyProfile: type: - string - 'null' email: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. phone: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. otherEmails: type: array description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. items: type: string workPhone: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. privatePhone: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. otherPhones: type: array description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. items: type: string workMobilePhone: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. privateMobilePhone: type: - string - 'null' description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. otherMobilePhones: type: array description: >- Available contact channel data; omitted unless the workspace entitlement exposes contact details. items: type: string contactId: type: - string - 'null' description: Saved contact identifier in this workgroup. Error: type: object required: - code - error properties: code: type: string description: Stable error code. Input validation uses VALIDATION_ERROR. error: type: string description: >- User-facing message. Unknown failures return a generic message without internal details. example: code: UNHANDLED_EXCEPTION error: Unexpected error RateLimitError: type: object description: Returned when a public OpenAPI rate limit is exceeded. properties: statusCode: type: integer example: 429 error: type: string example: Too Many Requests message: type: string description: Human-readable description of the limit that was exceeded. retryAfterSeconds: type: integer description: Seconds to wait before retrying the request. Location: type: object description: >- Public location details for a contact or professional experience. The contact's top-level location uses only the candidate's recorded profile location. properties: fullAddress: type: - string - 'null' description: >- Full location string when the source only supplied one combined address. address: type: - string - 'null' description: Street address when available. addressLine2: type: - string - 'null' description: Second address line when available. city: type: - string - 'null' description: City or locality. state: type: - string - 'null' description: >- State or region label. This mirrors region for integrations that expect a state field. region: type: - string - 'null' description: State, province, county, or region label. country: type: - string - 'null' description: Country name. countryCode: type: - string - 'null' description: Recorded country code, when available. postalCode: type: - string - 'null' description: Postal or ZIP code. Skill: type: object description: Enrichment skill attached to the contact. properties: value: type: - string - 'null' description: Skill label. skillType: type: - string - 'null' description: Optional skill category. level: type: - integer - 'null' description: Optional Jobin skill level. topSkill: type: - boolean - 'null' description: Whether the skill is marked as a top skill. Education: type: object description: Education entry exposed for candidate matching. properties: school: type: - string - 'null' description: School or institution name. schoolSocialUrl: type: - string - 'null' description: School profile URL when available. degreeLevel: type: - string - 'null' description: Normalized degree level when Jobin has one. degrees: type: array description: Degree strings imported from profile data. items: type: string fieldOfStudy: type: - string - 'null' description: Primary field of study. majors: type: array description: Major fields of study imported from profile data. items: type: string minors: type: array description: Minor fields of study imported from profile data. items: type: string period: oneOf: - $ref: '#/components/schemas/Period' - type: 'null' description: Education attendance period. Accomplishment: type: object description: >- Accomplishment, certification, award, or similar profile item attached to the contact. properties: value: type: - string - 'null' description: Accomplishment title. type: type: - string - 'null' description: Accomplishment type when categorized. issuer: type: - string - 'null' description: Issuer or authority for the accomplishment. description: type: - string - 'null' description: Longer accomplishment description. date: type: - string - 'null' format: date-time description: Date associated with the accomplishment. organization: oneOf: - $ref: '#/components/schemas/OrganizationSummary' - type: 'null' description: Organization associated with the accomplishment. Language: type: object description: Language entry attached to the contact. properties: value: type: - string - 'null' description: Language name. level: type: - integer - 'null' description: Optional Jobin language proficiency level. note: type: - string - 'null' description: Optional note about the language. VolunteerExperience: type: object description: Volunteer experience entry attached to the contact. properties: roleTitle: type: - string - 'null' description: Volunteer role title. organization: oneOf: - $ref: '#/components/schemas/OrganizationSummary' - type: 'null' description: Volunteer organization. cause: type: - string - 'null' description: Cause or category associated with the volunteer entry. description: type: - string - 'null' description: Volunteer role description. location: oneOf: - $ref: '#/components/schemas/Location' - type: 'null' description: Volunteer role location. period: oneOf: - $ref: '#/components/schemas/Period' - type: 'null' description: Volunteer role period. ContactExperience: type: object description: One professional experience from the contact's work history. properties: title: type: - string - 'null' description: Role title for this professional experience. company: type: - string - 'null' description: Company or organization name for this professional experience. from: type: - string - 'null' format: date-time description: Start date for this professional experience when available. to: type: - string - 'null' format: date-time description: End date for this professional experience when available. isCurrent: type: - boolean - 'null' description: Whether this professional experience is marked as current. location: oneOf: - $ref: '#/components/schemas/Location' - type: 'null' description: Role location for this professional experience when available. employmentType: type: - string - 'null' description: >- Employment type for this professional experience, such as full-time or contract, when available. description: type: - string - 'null' description: >- Responsibilities, achievements, or role description for this professional experience when available. Period: type: object description: >- Start/end window for education, volunteering, or other profile history entries. properties: from: type: - string - 'null' format: date-time description: Start date when available. to: type: - string - 'null' format: date-time description: End date when available. isCurrent: type: - boolean - 'null' description: Whether the period is currently active. OrganizationSummary: type: object description: Small public organization summary used by nested profile-history fields. properties: name: type: - string - 'null' description: Organization name. socialUrl: type: - string - 'null' description: Organization profile URL. companyWebsite: type: - string - 'null' description: Organization website URL. employeeCountRange: type: - string - 'null' description: Organization employee count range when available. responses: BadRequest: description: Invalid request or expected business-rule failure. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: >- Missing or invalid authentication, or missing required authentication context. content: application/json: schema: $ref: '#/components/schemas/Error' RateLimitExceeded: description: >- Rate limit exceeded. Wait for the retry-after header before sending the next request. headers: retry-after: description: Seconds to wait before retrying. schema: type: integer x-ratelimit-limit: description: Maximum requests allowed in the current window. schema: type: integer x-ratelimit-remaining: description: Requests remaining in the current window. schema: type: integer x-ratelimit-reset: description: Seconds until the current window resets. schema: type: integer content: application/json: schema: oneOf: - $ref: '#/components/schemas/RateLimitError' - $ref: '#/components/schemas/Error' InternalServerError: description: Unexpected server failure. Internal details are masked. content: application/json: schema: $ref: '#/components/schemas/Error' ApiError: description: Other client or server failure. Unknown errors expose a generic message. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.