Overview
Aptify is an association-management system. The Automize connector covers the member lifecycle — persons, companies, memberships, events and event registrations, orders, payments and invoices — plus generic record create/read/update/delete against any Aptify entity.
Setting up the connection
Auth type: login_exchange.
- Get the Aptify application root, without a trailing slash — e.g. https://members.example.org/AptifyServicesAPI.
- Use an Aptify user that has API access, not a staff member's day-to-day login.
- Leave Authentication provider as Web unless connecting to the admin API, which uses AptifyUser. It rides the login URL path, so a wrong value fails at login rather than later.
- Leave Token header name as Authorization unless this install overrides Aptify.Services.Authentication.HeaderName.
- In Automize, open Settings → Connectors → Aptify → Add connection and fill those in. Automize logs in per run and uses the returned token; leave the pre-issued token blank, since a pasted one expires and stops a scheduled process.
Available operations
20 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Check Connection | General | Confirm the service layer is reachable (returns the server's UTC time) |
| Create Record | General | Create a record of any Aptify entity |
| Delete Record | General | Delete a record of any Aptify entity |
| Get Company | General | Fetch one company by ID |
| Get Order | General | Fetch one order by ID |
| Get Person | General | Fetch one person by ID |
| Get Record | General | Fetch one record of any Aptify entity by ID |
| List Companies | General | List organisations - employers, member orgs, vendors |
| List Event Registrations | General | List attendance records for events |
| List Events | General | List events, meetings and conferences |
| List Invoices | General | List invoices raised against orders |
| List Memberships | General | List membership records linking persons or companies to membership types |
| List Orders | General | List sales / fulfilment order headers |
| List Payments | General | List payments recorded against orders |
| List Persons | General | List individual contacts and members |
| List Records | General | List records of any Aptify entity, paging through the whole set |
| Login | General | Re-authenticate and refresh the stored token |
| Logout | General | Invalidate the current token |
| Update Record | General | Update a record of any Aptify entity |
| User Information | General | Basic details of the currently authenticated user |
Operations
Check Connection
Confirm the service layer is reachable (returns the server's UTC time)
No input parameters.
Create Record
Create a record of any Aptify entity
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity entity | Yes | string | Aptify entity name, e.g. 'Persons', 'Orders', or a custom entity. |
Field values fields | Yes | object | Field name to value mapping to write. |
Delete Record
Delete a record of any Aptify entity
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity entity | Yes | string | Aptify entity name, e.g. 'Persons', 'Orders', or a custom entity. |
Record ID id | Yes | string | The record's Aptify ID. |
Get Company
Fetch one company by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Record ID id | Yes | string | The record's Aptify ID. |
Get Order
Fetch one order by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Record ID id | Yes | string | The record's Aptify ID. |
Get Person
Fetch one person by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Record ID id | Yes | string | The record's Aptify ID. |
Get Record
Fetch one record of any Aptify entity by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity entity | Yes | string | Aptify entity name, e.g. 'Persons', 'Orders', or a custom entity. |
Record ID id | Yes | string | The record's Aptify ID. |
List Companies
List organisations - employers, member orgs, vendors
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Event Registrations
List attendance records for events
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Events
List events, meetings and conferences
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Invoices
List invoices raised against orders
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Memberships
List membership records linking persons or companies to membership types
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Orders
List sales / fulfilment order headers
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Payments
List payments recorded against orders
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Persons
List individual contacts and members
| Parameter | Required | Type | Description |
|---|---|---|---|
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
List Records
List records of any Aptify entity, paging through the whole set
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity entity | Yes | string | Aptify entity name, e.g. 'Persons', 'Orders', or a custom entity. |
Filter filter | No | string | OData $filter expression, e.g. "LastName eq 'Smith'". |
Modified since modified_since | No | string | ISO-8601 timestamp. Returns only records changed since then, by adding a LastModifiedDate clause to the filter. Entities without that column will reject it. |
Order by orderby | No | string | OData $orderby expression, e.g. 'LastModifiedDate desc'. |
Select columns select | No | string | Comma-separated column list to return instead of every field. |
Maximum records top | No | integer | Stop after this many records. Leave blank to fetch every page. The server caps a single page at 500 regardless. |
Skip skip | No | integer | Number of records to skip before reading. |
Login
Re-authenticate and refresh the stored token
| Parameter | Required | Type | Description |
|---|---|---|---|
Username username | No | string | |
Password password | No | string | |
Authentication provider auth_provider | No | string |
Logout
Invalidate the current token
No input parameters.
Update Record
Update a record of any Aptify entity
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity entity | Yes | string | Aptify entity name, e.g. 'Persons', 'Orders', or a custom entity. |
Record ID id | Yes | string | The record's Aptify ID. |
Field values fields | Yes | object | Field name to value mapping to write. |
User Information
Basic details of the currently authenticated user
No input parameters.
FAQ
- When do I use Get Record instead of Get Person or Get Company?
- The named actions cover the entities most processes touch. Get Record, List Records, Create Record, Update Record and Delete Record take an entity name, so they reach anything else in the Aptify model — including entities specific to this install.