How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bird

Bird Email Contacts API

Contacts are the people you send broadcasts to. Each contact is unique by email address within a workspace and carries optional name fields and custom properties for personalization. Custom properties are defined once per workspace via the contact properties API and then set per contact.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bird Email Contacts API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include email-contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 12 operations across 7 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

12 operations 7 paths 28 schemas 1 DELETE4 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Email Contacts API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

email-contacts 12

Contacts are the people you send broadcasts to. Each contact is unique by email address within a workspace and carries optional name fields and custom properties for personalizati…

POST
/v1/contacts
Create a contact
createContact 1 param body → 201400401403409422429500
GET
/v1/contacts
List contacts
listContacts 9 params → 200401403422429500
POST
/v1/contacts/batch
Create or update contacts in bulk
createContactBatch 1 param body → 200400401403422429500503
GET
/v1/contacts/{contact_id}
Get a contact
getContact 1 param → 200401403404422429500
PATCH
/v1/contacts/{contact_id}
Update a contact
updateContact 2 params body → 200400401403404409422429
DELETE
/v1/contacts/{contact_id}
Delete a contact
deleteContact 2 params → 204401403404422429500503
POST
/v1/contact-properties
Create a contact property
createContactProperty 1 param body → 201400401403409422429500
GET
/v1/contact-properties
List contact properties
listContactProperties 3 params → 200401403422429500
GET
/v1/contact-properties/{property_id}
Get a contact property
getContactProperty 1 param → 200401403404422429500
PATCH
/v1/contact-properties/{property_id}
Update a contact property
updateContactProperty 2 params body → 200400401403404422429500
POST
/v1/contact-properties/{property_id}/archive
Archive a contact property
archiveContactProperty 2 params → 200401403404409422429500
POST
/v1/contact-properties/{property_id}/unarchive
Unarchive a contact property
unarchiveContactProperty 2 params → 200401403404409422429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), ContactCreateRequest (6 properties), ContactUpdateRequest (6 properties), NextAction (5 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
ContactPropertyID
string
ContactUpsertEntry
object
The identifiers a batch entry supplied, in the normalized form used for matching. A field is null when the entry did not include it. These values identify the…
3 properties 3 required
ErrorDetail
object
2 properties 2 required
ContactID
string
ErrorBody
object
11 properties 6 required
ContactIdentifierFilter
string
Which identifier a contact has on file, email for an email address or phonenumber for a phone number.
NextAction
object
5 properties 2 required
Timestamps
object
2 properties 2 required
ContactUpsertResultItem
object
5 properties 3 required
ContactUpdateRequest
object
6 properties
ContactPropertyList
ContactUpsertError
object
3 properties 3 required
_ListEnvelopeWithTotal
ContactCreateRequest
object
6 properties
AudienceID
string
Contact
ContactMatchedOn
stringnull
Which identifier matched a batch entry to an existing contact. null when the entry created a new contact.
ContactList
ContactUpsertResult
object
1 property 1 required
ContactPropertyType
string
The value type every contact must use for a property. Cannot be changed after creation. datetime values are RFC 3339 timestamps with an explicit offset. Exampl…
ContactProperty
Error
object
1 property 1 required
ContactUpsertRequest
object
4 properties 1 required
ContactPropertyCreateRequest
object
3 properties 2 required
AudienceRef
object
A compact reference to an audience, carrying its ID and display name.
2 properties 2 required
ContactMatchKey
string
A contact identifier a batch entry can be matched on.
ContactPropertyUpdateRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-contacts-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
AE Profile APIs.io
Bird Phone Numbers API
AE Profile APIs.io
Bird Identity Verification API
AE Profile APIs.io
Bird Touchpoints API
AE Profile APIs.io
Bird Accounts API
AE Profile APIs.io
Bird FAQ API
AE Profile APIs.io
Bird Intent API
AE Profile APIs.io
Bird SMS Messaging API
AE Profile APIs.io
Bird Channels API
AE Profile APIs.io
Bird Contacts API
AE Profile APIs.io
Bird Conversations API
AE Profile APIs.io
Bird Legacy MessageBird API
AE Profile APIs.io
#email-contacts
← Back to B APIs
API Details
ID
bird:bird-email-contacts-api
Base URL
https://api.bird.com
Docs
https://docs.bird.com/api
Provider
Bird
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bird-email-contacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bird-email-contacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bird Email Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.