# Affinity Developer Documentation ## Docs - [Get current user](https://developer.affinity.co/api-reference/auth/get-current-user.md): Returns information about the authenticated user, their current organization, and API key permissions. Use this endpoint to verify your authentication and understand your available API access levels. - [Get metadata on all Calls](https://developer.affinity.co/api-reference/calls/get-metadata-on-all-calls.md): Paginate through all calls in Affinity. Returns basic information about the call interaction and its participants. Will only return calls that the current authenticated user has permission to see. - [Get metadata on all Chat Messages](https://developer.affinity.co/api-reference/chat-messages/get-metadata-on-all-chat-messages.md): Paginate through all chat messages in Affinity. Returns basic information about the chat message interaction and its participants. Will only return chat messages that the current authenticated user has permission to see. - [Get a Company's List Entries](https://developer.affinity.co/api-reference/companies/get-a-companys-list-entries.md): Paginate through the List Entries (AKA rows) for the given Company across all Lists. Each List Entry includes field data for the Company, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. - [Get a Company's Lists](https://developer.affinity.co/api-reference/companies/get-a-companys-lists.md): Paginate through all Lists where the given Company appears as an entry and that you have access to view. Returns basic List information for each List that contains this Company. - [Get a single Company](https://developer.affinity.co/api-reference/companies/get-a-single-company.md): Returns basic information and non-list-specific field data on the requested Company. - [Get a single field value on a Company](https://developer.affinity.co/api-reference/companies/get-a-single-field-value-on-a-company.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get all Companies](https://developer.affinity.co/api-reference/companies/get-all-companies.md): Paginate through Companies in Affinity. Returns basic information and non-list-specific field data on each Company. - [Get field values on a single Company](https://developer.affinity.co/api-reference/companies/get-field-values-on-a-single-company.md): | ⚠️ This endpoint is currently in BETA | |--| Paginate through field values on a single company. - [Get metadata on Company Fields](https://developer.affinity.co/api-reference/companies/get-metadata-on-company-fields.md): Returns metadata on non-list-specific Company Fields. - [Get Notes for a Company](https://developer.affinity.co/api-reference/companies/get-notes-for-a-company.md): Returns relevant notes for a given company which includes directly attached notes and notes attached to persons on this company. - [Perform batch operations on a company's fields](https://developer.affinity.co/api-reference/companies/perform-batch-operations-on-a-companys-fields.md): | ⚠️ This endpoint is currently in BETA | |--| Perform batch operations on a company's fields. - [Update a single field value on a Company](https://developer.affinity.co/api-reference/companies/update-a-single-field-value-on-a-company.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get All Company Merge Tasks](https://developer.affinity.co/api-reference/company-merges/get-all-company-merge-tasks.md): Retrieve paginated company merge tasks for the organization. - [Get All Company Merges](https://developer.affinity.co/api-reference/company-merges/get-all-company-merges.md): Retrieve paginated company merges for the organization. - [Get Company Merge](https://developer.affinity.co/api-reference/company-merges/get-company-merge.md): Retrieve the status and details of a specific company merge. - [Get Company Merge Task](https://developer.affinity.co/api-reference/company-merges/get-company-merge-task.md): Retrieve the status and details of a specific task for company merges. - [Initiate Company Merge](https://developer.affinity.co/api-reference/company-merges/initiate-company-merge.md): Initiate a company merge to combine a duplicate company profile into a primary company profile. - [Get metadata on all Emails](https://developer.affinity.co/api-reference/emails/get-metadata-on-all-emails.md): Paginate through all emails in Affinity. Returns basic information about the email interaction and its participants. Will only return emails or subject lines that the current authenticated user has permission to see. - [Send Feedback](https://developer.affinity.co/api-reference/feedback/send-feedback.md): Send feedback to Affinity about a particular product area or feature. - [Get a single field value](https://developer.affinity.co/api-reference/lists/get-a-single-field-value.md): Returns a single field value on a list entry. - [Get a single List Entry on a List](https://developer.affinity.co/api-reference/lists/get-a-single-list-entry-on-a-list.md): Retrieve a single list entry. Returns basic information and field data, including list-specific field data. - [Get all List Entries on a List](https://developer.affinity.co/api-reference/lists/get-all-list-entries-on-a-list.md): Paginate through the List Entries (AKA rows) on a given List. Returns basic information and field data, including list-specific field data, on each Company, Person, or Opportunity on the List. List Entries also include metadata about their creation, i.e., when they were added to the List and by whom… - [Get all List Entries on a Saved View](https://developer.affinity.co/api-reference/lists/get-all-list-entries-on-a-saved-view.md): Paginate through the List Entries (AKA rows) on a given Saved View. Use this endpoint when you need to filter entities or only want **some** field data to be returned: This endpoint respects the filters set on a Saved View via web app, and only returns field data corresponding to the columns that ha… - [Get dropdown options for a List Field](https://developer.affinity.co/api-reference/lists/get-dropdown-options-for-a-list-field.md): Returns the dropdown options for a specific dropdown or ranked-dropdown field on a List. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints. - [Get field values on a single List Entry](https://developer.affinity.co/api-reference/lists/get-field-values-on-a-single-list-entry.md): Paginate through all field values on a single list entry. - [Get metadata on a single List](https://developer.affinity.co/api-reference/lists/get-metadata-on-a-single-list.md): Retrieve detailed information about a specific List you have access to view. Returns List configuration including name, owner, privacy settings, and creation details. - [Get metadata on a single List's Fields](https://developer.affinity.co/api-reference/lists/get-metadata-on-a-single-lists-fields.md): Returns metadata on the Fields available on a single List. - [Get metadata on a single Saved View](https://developer.affinity.co/api-reference/lists/get-metadata-on-a-single-saved-view.md): Retrieve detailed information about a specific Saved View you have access to view. Returns complete Saved View configuration including name, sorting, and column visibility settings. - [Get metadata on all Lists](https://developer.affinity.co/api-reference/lists/get-metadata-on-all-lists.md): Paginate through all Lists in your organization that you have access to view. Returns basic information about each List, including name, owner, and privacy settings. - [Get metadata on Saved Views](https://developer.affinity.co/api-reference/lists/get-metadata-on-saved-views.md): Paginate through all Saved Views you have access to view for a specific List. Returns Saved View configurations including name, column settings, and owner information. - [Perform batch operations on a list entry's fields](https://developer.affinity.co/api-reference/lists/perform-batch-operations-on-a-list-entrys-fields.md): Perform batch operations on a list entry's fields. - [Update a single field value on a List Entry](https://developer.affinity.co/api-reference/lists/update-a-single-field-value-on-a-list-entry.md): Update a single field value. Requires the "Export data from Lists" [permission](/pages/external-api-v2/permissions). - [Get metadata on all Meetings](https://developer.affinity.co/api-reference/meetings/get-metadata-on-all-meetings.md): Paginate through all Meetings in Affinity. Returns basic information about past and future meeting interactions and its attendees. - [Get a single Note](https://developer.affinity.co/api-reference/notes/get-a-single-note.md): Get a Note with a given id - [Get all Notes](https://developer.affinity.co/api-reference/notes/get-all-notes.md): Returns all notes, with the exception of replies. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Description**… - [Get Companies attached to a Note](https://developer.affinity.co/api-reference/notes/get-companies-attached-to-a-note.md): Returns directly attached companies for a given Note. - [Get Opportunities attached to a Note](https://developer.affinity.co/api-reference/notes/get-opportunities-attached-to-a-note.md): Returns directly attached opportunities for a given Note. - [Get Persons attached to a Note](https://developer.affinity.co/api-reference/notes/get-persons-attached-to-a-note.md): Returns directly attached persons for a given Note. - [Get replies for a Note](https://developer.affinity.co/api-reference/notes/get-replies-for-a-note.md): This endpoint returns reply notes for a given note id. You can filter replies using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Description**… - [Get a single Opportunity](https://developer.affinity.co/api-reference/opportunities/get-a-single-opportunity.md): Returns basic information but **not** field data on the requested Opportunity. - [Get all Opportunities](https://developer.affinity.co/api-reference/opportunities/get-all-opportunities.md): Paginate through Opportunities in Affinity. Returns basic information but **not** field data on each Opportunity. - [Get Notes for an Opportunity](https://developer.affinity.co/api-reference/opportunities/get-notes-for-an-opportunity.md): Returns Notes for a given Opportunity which includes directly attached notes and those attached to persons on this Opportunity. - [Get All Person Merge Tasks](https://developer.affinity.co/api-reference/person-merges/get-all-person-merge-tasks.md): Retrieve paginated person merge tasks for the organization. - [Get All Person Merges](https://developer.affinity.co/api-reference/person-merges/get-all-person-merges.md): Retrieve paginated person merges for the organization. - [Get Person Merge](https://developer.affinity.co/api-reference/person-merges/get-person-merge.md): Retrieve the status and details of a specific person merge. - [Get Person Merge Task](https://developer.affinity.co/api-reference/person-merges/get-person-merge-task.md): Retrieve the status and details of a specific task for person merges. - [Initiate Person Merge](https://developer.affinity.co/api-reference/person-merges/initiate-person-merge.md): Initiate a person merge to combine a duplicate person profile into a primary person profile. - [Get a Person's List Entries](https://developer.affinity.co/api-reference/persons/get-a-persons-list-entries.md): Paginate through the List Entries (AKA rows) for the given Person across all Lists. Each List Entry includes field data for the Person, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. - [Get a Person's Lists](https://developer.affinity.co/api-reference/persons/get-a-persons-lists.md): Paginate through all Lists where the given Person appears as an entry and that you have access to view. Returns basic List information for each List that contains this Person. - [Get a single field on a Person](https://developer.affinity.co/api-reference/persons/get-a-single-field-on-a-person.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get a single Person](https://developer.affinity.co/api-reference/persons/get-a-single-person.md): Returns basic information and non-list-specific field data on the requested Person. - [Get all Persons](https://developer.affinity.co/api-reference/persons/get-all-persons.md): Paginate through Persons in Affinity. Returns basic information and non-list-specific field data on each Person. - [Get field values on a single Person](https://developer.affinity.co/api-reference/persons/get-field-values-on-a-single-person.md): | ⚠️ This endpoint is currently in BETA | |--| Paginate through field values on a single person. - [Get metadata on Person Fields](https://developer.affinity.co/api-reference/persons/get-metadata-on-person-fields.md): Returns metadata on non-list-specific Person Fields. - [Get Notes for a Person](https://developer.affinity.co/api-reference/persons/get-notes-for-a-person.md): Returns notes for a given person id which includes directly attached notes, notes on meetings this person attended, and notes where this person is mentioned. - [Perform batch operations on a person's fields](https://developer.affinity.co/api-reference/persons/perform-batch-operations-on-a-persons-fields.md): | ⚠️ This endpoint is currently in BETA | |--| Perform batch operations on a person's fields. - [Update a single field value on a Person](https://developer.affinity.co/api-reference/persons/update-a-single-field-value-on-a-person.md): | ⚠️ This endpoint is currently in BETA | |--| - [Semantic Search](https://developer.affinity.co/api-reference/semantic-search/semantic-search.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get a single Transcript](https://developer.affinity.co/api-reference/transcripts/get-a-single-transcript.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get all Transcripts](https://developer.affinity.co/api-reference/transcripts/get-all-transcripts.md): | ⚠️ This endpoint is currently in BETA | |--| - [Get fragments of a transcript](https://developer.affinity.co/api-reference/transcripts/get-fragments-of-a-transcript.md): | ⚠️ This endpoint is currently in BETA | |--| - [Previous Changes](https://developer.affinity.co/pages/changelog/previous-changes.md) - [Nested Associations](https://developer.affinity.co/pages/data-model/nested-associations.md) - [The Basics](https://developer.affinity.co/pages/data-model/the-basics.md) - [Working with Field Data](https://developer.affinity.co/pages/data-model/working-with-field-data.md) - [Calls](https://developer.affinity.co/pages/data-share/calls_beta_v0_2.md) - [Calls Companies](https://developer.affinity.co/pages/data-share/calls_companies_beta_v0_2.md) - [Calls Companies](https://developer.affinity.co/pages/data-share/calls_companies_v1_0.md) - [Calls Persons](https://developer.affinity.co/pages/data-share/calls_persons_beta_v0_2.md) - [Calls Persons](https://developer.affinity.co/pages/data-share/calls_persons_v1_0.md) - [Calls](https://developer.affinity.co/pages/data-share/calls_v1_0.md) - [Chat Messages](https://developer.affinity.co/pages/data-share/chat_messages_beta_v0_2.md) - [Chat Messages Companies](https://developer.affinity.co/pages/data-share/chat_messages_companies_beta_v0_2.md) - [Chat Messages Companies](https://developer.affinity.co/pages/data-share/chat_messages_companies_v1_0.md) - [Chat Messages Persons](https://developer.affinity.co/pages/data-share/chat_messages_persons_beta_v0_2.md) - [Chat Messages Persons](https://developer.affinity.co/pages/data-share/chat_messages_persons_v1_0.md) - [Chat Messages](https://developer.affinity.co/pages/data-share/chat_messages_v1_0.md) - [Companies](https://developer.affinity.co/pages/data-share/companies_beta_v0_2.md) - [Companies Persons](https://developer.affinity.co/pages/data-share/companies_persons_beta_v0_2.md) - [Companies Persons](https://developer.affinity.co/pages/data-share/companies_persons_v1_0.md) - [Companies](https://developer.affinity.co/pages/data-share/companies_v1_0.md) - [Data Access](https://developer.affinity.co/pages/data-share/data_access.md): How data visibility works in the Data Share - [Deletes](https://developer.affinity.co/pages/data-share/deletes.md): How record deletions are handled in the Data Share - [Emails](https://developer.affinity.co/pages/data-share/emails_beta_v0_2.md) - [Emails Companies](https://developer.affinity.co/pages/data-share/emails_companies_beta_v0_2.md) - [Emails Companies](https://developer.affinity.co/pages/data-share/emails_companies_v1_0.md) - [Emails Persons](https://developer.affinity.co/pages/data-share/emails_persons_beta_v0_2.md) - [Emails Persons](https://developer.affinity.co/pages/data-share/emails_persons_v1_0.md) - [Emails](https://developer.affinity.co/pages/data-share/emails_v1_0.md) - [Example Queries](https://developer.affinity.co/pages/data-share/example_queries.md): Common SQL patterns for working with Data Share tables (Beta V0.2 schema) - [Fields Metadata](https://developer.affinity.co/pages/data-share/fields_metadata_beta_v0_2.md) - [Fields Metadata](https://developer.affinity.co/pages/data-share/fields_metadata_v1_0.md) - [List Entries](https://developer.affinity.co/pages/data-share/list_entries_beta_v0_2.md) - [List Entries Companies](https://developer.affinity.co/pages/data-share/list_entries_companies_beta_v0_2.md) - [List Entries Companies](https://developer.affinity.co/pages/data-share/list_entries_companies_v1_0.md) - [List Entries Opportunities](https://developer.affinity.co/pages/data-share/list_entries_opportunities_beta_v0_2.md) - [List Entries Opportunities](https://developer.affinity.co/pages/data-share/list_entries_opportunities_v1_0.md) - [List Entries Persons](https://developer.affinity.co/pages/data-share/list_entries_persons_beta_v0_2.md) - [List Entries Persons](https://developer.affinity.co/pages/data-share/list_entries_persons_v1_0.md) - [List Entries](https://developer.affinity.co/pages/data-share/list_entries_v1_0.md) - [Lists](https://developer.affinity.co/pages/data-share/lists_beta_v0_2.md) - [Lists](https://developer.affinity.co/pages/data-share/lists_v1_0.md) - [Meetings](https://developer.affinity.co/pages/data-share/meetings_beta_v0_2.md) - [Meetings Companies](https://developer.affinity.co/pages/data-share/meetings_companies_beta_v0_2.md) - [Meetings Companies](https://developer.affinity.co/pages/data-share/meetings_companies_v1_0.md) - [Meetings Persons](https://developer.affinity.co/pages/data-share/meetings_persons_beta_v0_2.md) - [Meetings Persons](https://developer.affinity.co/pages/data-share/meetings_persons_v1_0.md) - [Meetings](https://developer.affinity.co/pages/data-share/meetings_v1_0.md) - [Notes](https://developer.affinity.co/pages/data-share/notes_beta_v0_2.md) - [Notes Chat Messages](https://developer.affinity.co/pages/data-share/notes_chat_messages_beta_v0_2.md) - [Notes Chat Messages](https://developer.affinity.co/pages/data-share/notes_chat_messages_v1_0.md) - [Notes Companies](https://developer.affinity.co/pages/data-share/notes_companies_beta_v0_2.md) - [Notes Companies](https://developer.affinity.co/pages/data-share/notes_companies_v1_0.md) - [Notes Emails](https://developer.affinity.co/pages/data-share/notes_emails_beta_v0_2.md) - [Notes Emails](https://developer.affinity.co/pages/data-share/notes_emails_v1_0.md) - [Notes Meetings](https://developer.affinity.co/pages/data-share/notes_meetings_beta_v0_2.md) - [Notes Meetings](https://developer.affinity.co/pages/data-share/notes_meetings_v1_0.md) - [Notes Opportunities](https://developer.affinity.co/pages/data-share/notes_opportunities_beta_v0_2.md) - [Notes Opportunities](https://developer.affinity.co/pages/data-share/notes_opportunities_v1_0.md) - [Notes Persons](https://developer.affinity.co/pages/data-share/notes_persons_beta_v0_2.md) - [Notes Persons](https://developer.affinity.co/pages/data-share/notes_persons_v1_0.md) - [Notes](https://developer.affinity.co/pages/data-share/notes_v1_0.md) - [Opportunities](https://developer.affinity.co/pages/data-share/opportunities_beta_v0_2.md) - [Opportunities Companies](https://developer.affinity.co/pages/data-share/opportunities_companies_beta_v0_2.md) - [Opportunities Companies](https://developer.affinity.co/pages/data-share/opportunities_companies_v1_0.md) - [Opportunities Persons](https://developer.affinity.co/pages/data-share/opportunities_persons_beta_v0_2.md) - [Opportunities Persons](https://developer.affinity.co/pages/data-share/opportunities_persons_v1_0.md) - [Opportunities](https://developer.affinity.co/pages/data-share/opportunities_v1_0.md) - [Overview](https://developer.affinity.co/pages/data-share/overview.md): Affinity Data Share — available tables and schema reference - [Persons](https://developer.affinity.co/pages/data-share/persons_beta_v0_2.md) - [Persons](https://developer.affinity.co/pages/data-share/persons_v1_0.md) - [Refresh Cadence](https://developer.affinity.co/pages/data-share/refresh_cadence.md): How often Data Share tables are updated - [Relationship Strengths](https://developer.affinity.co/pages/data-share/relationship_strengths_beta_v0_2.md) - [Relationship Strengths](https://developer.affinity.co/pages/data-share/relationship_strengths_v1_0.md) - [Subdomain](https://developer.affinity.co/pages/data-share/subdomain.md): How subdomain identifies your Affinity instance - [Transcripts](https://developer.affinity.co/pages/data-share/transcripts_beta_v0_2.md) - [Transcripts](https://developer.affinity.co/pages/data-share/transcripts_v1_0.md) - [Versioning & Deprecation](https://developer.affinity.co/pages/data-share/versioning.md): How Data Share schemas are versioned and what to expect when things change - [Authentication](https://developer.affinity.co/pages/external-api-v2/authentication.md) - [Beta Endpoints](https://developer.affinity.co/pages/external-api-v2/beta-endpoints.md) - [Error Codes](https://developer.affinity.co/pages/external-api-v2/error-codes.md) - [Filtering](https://developer.affinity.co/pages/external-api-v2/filtering.md) - [Getting Started](https://developer.affinity.co/pages/external-api-v2/getting-started.md) - [Introduction](https://developer.affinity.co/pages/external-api-v2/introduction.md) - [Pagination](https://developer.affinity.co/pages/external-api-v2/pagination.md) - [Permissions](https://developer.affinity.co/pages/external-api-v2/permissions.md) - [Rate Limits](https://developer.affinity.co/pages/external-api-v2/rate-limits.md) - [Versioning](https://developer.affinity.co/pages/external-api-v2/versioning.md) - [Authentication](https://developer.affinity.co/pages/mcp/authentication.md): Learn how to authenticate with the Affinity MCP Server - [Available Tools](https://developer.affinity.co/pages/mcp/available-tools.md): Explore the tools and capabilities provided by the Affinity MCP Server - [Introduction](https://developer.affinity.co/pages/mcp/introduction.md): Connect your AI assistant to Affinity with the MCP Server - [Local Setup](https://developer.affinity.co/pages/mcp/local-setup.md): Run the Affinity MCP server locally using STDIO - [Hosted Setup](https://developer.affinity.co/pages/mcp/setup.md): Learn how to connect your AI assistant to the Affinity hosted MCP server - [Troubleshooting](https://developer.affinity.co/pages/mcp/troubleshooting.md): Diagnose and fix common issues with the Affinity MCP Server ## OpenAPI Specs - [publish](https://developer.affinity.co/schema/temp/publish.yml) - [openapi](https://developer.affinity.co/api-reference/openapi.json)