large_CPL_6410.png

medium_CPL_6410.png

small_CPL_6410.png

thumbnail_CPL_6410.png

CPL_6410.png

See how Burger King deployed our receipt scanning technology to quickly launch their Kingdom Rewards loyalty program without the need to invest time and money integrating with multiple ePOS systems.

medium_bk1.png

small_bk1.png

thumbnail_bk1.png

bk1.png

Connect your loyalty program in Affinity without researching its API, registering in a developer program, and getting your application approved. We take care of authentication, secure credentials storage, and token refreshes so you don't have to.

Affinity

Returns metadata about the current user.

Get current user

Paginate through Companies in Affinity.
Returns basic information and non-list-specific field data on each Company.
To retrieve field data, you must use either the <code>fieldIds</code> or the <code>fieldTypes</code> parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET <code>/v2/companies/fields</code> endpoint.
When no <code>fieldIds</code> or <code>fieldTypes</code> are provided, Companies will be returned without any field data attached.
To supply multiple <code>fieldIds</code> or <code>fieldTypes</code> parameters, generate a query string that looks like this:
<code>?fieldIds=field-1234&amp;fieldIds=affinity-data-location</code> or <code>?fieldTypes=enriched&amp;fieldTypes=global</code>.
Requires the "Export All Organizations directory" <a>permission</a>.

Get all Companies

Returns basic information and non-list-specific field data on the requested Company.
To retrieve field data, you must use either the <code>fieldIds</code> or the <code>fieldTypes</code> parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET <code>/v2/companies/fields</code> endpoint.
When no <code>fieldIds</code> or <code>fieldTypes</code> are provided, Companies will be returned without any field data attached.
To supply multiple <code>fieldIds</code> or <code>fieldTypes</code> parameters, generate a query string that looks like this:
<code>?fieldIds=field-1234&amp;fieldIds=affinity-data-location</code> or <code>?fieldTypes=enriched&amp;fieldTypes=global</code>.
Requires the "Export All Organizations directory" <a>permission</a>.

Get a single Company

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

Get metadata on Company Fields

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

Get a Company's Lists

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.
Requires the "Export data from Lists" <a>permission</a>.

Get a Company's List Entries

Get metadata on all Lists

Get metadata on a single List

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.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all List Entries on a List

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.

Get metadata on a single List's Fields

Returns metadata on the Saved Views on a List.

Get metadata on Saved Views

Get metadata on a single Saved View

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 have been
pulled into the Saved View via web app.

Though this endpoint respects the Saved View's filters and column/Field selection,
it does not yet preserve sort order. This endpoint also only supports **sheet-type
Saved Views**, and not board- or dashboard-type Saved Views.

See the [Data Model](#section/Data-Model) section for more information about Saved Views.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all List Entries on a Saved View

Paginate through Opportunities in Affinity.
Returns basic information but **not** field data on each Opportunity.

To access field data on Opportunities, use the `/lists/{list_id}/list-entries`
or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all Opportunities

Returns basic information but **not** field data on the requested Opportunity.

To access field data on Opportunities, use the `/lists/{list_id}/list-entries`
or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get a single Opportunity

Paginate through Persons in Affinity.
Returns basic information and non-list-specific field data on each Person.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All People directory" [permission](#section/Getting-Started/Permissions).

Get all Persons

Returns basic information and non-list-specific field data on the requested Person.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All People directory" [permission](#section/Getting-Started/Permissions).

Get a single Person

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.

Get metadata on Person Fields

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

Get a Person's Lists

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.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

	list	find By Id	create	update	search	delete
Companies
Company List Entries
Company Lists
List Entries
Lists

White Label Loyalty + Affinity integration

About Affinity

Similar Integrations

Gong

Teamleader

Keap

HubSpot

Benefits of White Label Loyalty + Affinity

Integrate now!

Automate desired actions with Affinity

Get current user

Get metadata on Company Fields

Get all Companies

Get a Company's Lists

Get a single Company

Get a Company's List Entries

Call and retrieve data from Affinity

Burger King

Choose White Label Loyalty and become a loyalty leader