> ## Documentation Index
> Fetch the complete documentation index at: https://api.tryspecter.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create people list
> Creates a new people list shared with the API and returns its ID.
Free. This call does not consume credits.
## What you need
A unique list name; optionally the person IDs to seed it.
## Behaviour
- Pass `name` (required); it must be unique.
- Optionally seed the list with `people_ids`.
- Set `is_public` to share the list with your team.
- Add people later via [Update people list](/api-reference/people-lists/update-people-list).
- The list owner is the first team admin on the account.
## What you do next
- **Add or remove people.** Update membership with [Update people list](/api-reference/people-lists/update-people-list).
- **Pull the list.** Get its people with [Get people list results](/api-reference/people-lists/get-people-list-results).
## OpenAPI
````yaml /api-ref/bundle_api.yaml post /lists/people
openapi: 3.0.0
info:
title: Specter API
termsOfService: https://tryspecter.com/terms/
contact:
name: API support
email: api-support@tryspecter.com
version: 1.0.0
servers:
- description: Production
url: https://app.tryspecter.com/api/v1
security:
- ApiKeyAuth: []
tags:
- name: Enrich
description: >
Look up a company, person, or investor and, if Specter does not already
hold it, fetch it on demand. Includes email-based person enrichment.
- name: Search
description: |
Find records across every product from a single plain-English query.
- name: Companies
description: >
Company profiles, funding, headcount, traction, the per-company signals
and sub-resources attached to a single company, and identifier resolution.
- name: People
description: >
Specter people records: profile data, contact details, and per-person
lookups for a known person ID.
- name: Investors
description: >
Specter investor records: profile, activity, targeting, funds, portfolio
companies, and the funding rounds they have participated in.
- name: Transactions
description: |
Transaction detail by ID: funding rounds, acquisitions, and IPOs.
- name: News Signals
description: |
Company-level news signals: by ID, and for a saved list or company search.
- name: Revenue Signals
description: >
Revenue and profitability signals: by ID, by date, and for a saved list or
company search.
- name: Talent Signals
description: |
Talent signals: by ID and in bulk by ID.
- name: Investor Interest Signals
description: |
Investor interest signals: by ID and in bulk by ID.
- name: Company Lists
description: |
Create, query, and maintain lists of companies, including their results.
- name: Investor Lists
description: |
Create, query, and maintain lists of investors, including their results.
- name: People Lists
description: |
Create, query, and maintain lists of people, including their results.
- name: Saved Searches
description: |
List and delete searches saved via tryspecter.com.
- name: Company Saved Searches
description: |
Details and results for saved company searches.
- name: People Saved Searches
description: |
Details and results for saved people searches.
- name: Investor Saved Searches
description: |
Details and results for saved investor searches.
- name: Talent Signals Saved Searches
description: |
Details and results for saved Talent Signals searches.
- name: Investor Interest Saved Searches
description: |
Details and results for saved Investor Interest Signals searches.
- name: Network
description: >
Your team's LinkedIn network: the people and companies your teammates are
connected to, and your reach into a given company.
- name: Account
description: >
Organisation-level resources: your team's members, API call logs, and
credit balance.
paths:
/lists/people:
post:
tags:
- People Lists
summary: Create people list
description: >
Creates a new people list shared with the API and returns its ID.
Free. This call does not consume credits.
## What you need
A unique list name; optionally the person IDs to seed it.
## Behaviour
- Pass `name` (required); it must be unique.
- Optionally seed the list with `people_ids`.
- Set `is_public` to share the list with your team.
- Add people later via [Update people
list](/api-reference/people-lists/update-people-list).
- The list owner is the first team admin on the account.
## What you do next
- **Add or remove people.** Update membership with [Update people
list](/api-reference/people-lists/update-people-list).
- **Pull the list.** Get its people with [Get people list
results](/api-reference/people-lists/get-people-list-results).
operationId: createPeopleList
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the list to create
example: My list
people_ids:
type: array
items:
type: string
description: ID of people being added
example: per_9bc79341808a72461d634256
is_public:
type: boolean
description: Whether the list is shared with other users in the team
example: true
required:
- name
example:
name: My Watchlist
people_ids:
- per_34f8a8ad1f7497b83e821345
- per_fd73fc69269b7f4d73b79def
- per_742509725dfaa1b6b0b99acd
responses:
'201':
description: The ID of the list that was created
content:
application/json:
schema:
type: string
description: ID of the list
example: a1d2434c-e089-480a-8a27-9909d2f558b4
format: uuid
'400':
$ref: '#/components/responses/NoAdmin'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimits'
components:
responses:
NoAdmin:
description: Operation can't be done with no team admin
content:
application/json:
schema:
type: object
properties:
errorCode:
type: string
description: The type of error.
message:
type: string
examples:
no-team-admin:
summary: No admin for the team
value:
errorCode: NO_TEAM_ADMIN
message: >
Cannot process request without a team admin, please request a
team admin is added to your account.
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ApiKeyMissing'
- $ref: '#/components/schemas/ApiKeyNotValid'
Forbidden:
description: Forbidden - There is no permissions to use the endpoint
content:
application/json:
schema:
type: object
properties:
errorCode:
description: NOT_PERMITTED
type: string
example: NOT_PERMITTED
message:
type: string
description: You do not have permission to access this resource.
example: You do not have permission to access this resource.
required:
- errorCode
- message
RateLimits:
description: Too Many Requests - API Rate limit exceeded
content:
application/json:
schema:
type: object
required:
- errorCode
- message
properties:
errorCode:
type: string
description: RATE_LIMITED
message:
type: string
description: You have been rate-limited
headers:
X-RateLimit-Limit:
schema:
type: integer
description: The total rate limit allowed for this endpoint
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining
X-RateLimit-Reset:
schema:
type: number
format: float
description: The number of seconds until the rate limit resets
schemas:
ApiKeyMissing:
properties:
errorCode:
description: API_KEY_MISSING
example: API_KEY_MISSING
type: string
message:
description: No API Key was presented on the header X-API-KEY
example: No API Key was presented on the header X-API-KEY
type: string
ApiKeyNotValid:
properties:
errorCode:
description: API_KEY_NOT_VALID
example: API_KEY_NOT_VALID
type: string
message:
description: API key present, but not valid
example: API key present, but not valid
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````