Affinity

Tools (20)

• Get a company s list entries

  Summarize company data across all lists, including list-specific fields and metadata like creation date and author. Access requires "Export data from Lists" permission.

  Inputs: id, limit, cursor

• Get a company s lists

  Returns metadata for all the Lists on which the given Company appears.

  Inputs: id, limit, cursor

• Get all companies

  Affinity API allows paginated access to company info and custom fields. Use `fieldIds` or `fieldTypes` to specify data in a request. Retrieve field IDs/Types via GET `/v2/companies/fields`. Export permission needed.

  Inputs: ids, limit, cursor, fieldIds, fieldTypes

• Get all list entries on a list

  Access and export essential data and metadata for Companies, Persons, or Opportunities from a List, specifying data via `fieldIds` or `fieldTypes`. "Export data from Lists" permission is necessary.

  Inputs: limit, cursor, listId, fieldIds, fieldTypes

• Get all list entries on a saved view

  Use the endpoint to access rows in a Saved View with specific filters and selected fields from a web app. It doesn't maintain sort order, supports only sheet-type views, and requires export permissions.

  Inputs: limit, cursor, listId, viewId

• Get all opportunities

  Pagination through Opportunities in Affinity yields basic info but excludes field data. For field data, use specified GET endpoints. "Export data from Lists" permission needed.

  Inputs: ids, limit, cursor

• Get all persons

  The Affinity API offers paginated access to Person data using `fieldIds` or `fieldTypes`. Bulk extraction needs special permissions and supports multiple parameters.

  Inputs: ids, limit, cursor, fieldIds, fieldTypes

• Get a person s list entries

  Summary: Browse rows for a Person in all Lists, showing field data and entry metadata like creation time and author. Requires "Export data from Lists" permission.

  Inputs: id, limit, cursor

• Get a person s lists

  Returns metadata for all the Lists on which the given Person appears.

  Inputs: id, limit, cursor

• Get a single company

  Retrieve basic company info and specific field data by using `fieldIds` or `fieldTypes` parameters. Multiple fields can be queried. No field data if parameters aren't specified. Requires "Export All Organizations directory" permission.

  Inputs: id, fieldIds, fieldTypes

• Get a single opportunity

  Get basic details about an Opportunity without field data via provided endpoints. Field data requires using specific list entry APIs and the "Export data from Lists" permission.

  Inputs: id

• Get a single person

  Use GET `/v2/persons/fields` with `fieldIds` or `fieldTypes` for detailed data; basic info by default. Request multiple fields at once. "Export All People" permission needed.

  Inputs: id, fieldIds, fieldTypes

• Get current user

  Returns metadata about the current user.

• Get metadata on all lists

  Returns metadata on Lists.

  Inputs: limit, cursor

• Get metadata on a single list

  Returns metadata on a single List.

  Inputs: listId

• Get metadata on a single list s fields

  Returns metadata on the Fields available on a single List. Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.

  Inputs: limit, cursor, listId

• Get metadata on a single saved view

  Returns metadata on a single Saved View.

  Inputs: listId, viewId

• Get metadata on company fields

  Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.

  Inputs: limit, cursor

• Get metadata on person fields

  Returns metadata on non-list-specific Person Fields. Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.

  Inputs: limit, cursor

• Get metadata on saved views

  Returns metadata on the Saved Views on a List.

  Inputs: limit, cursor, listId