This topic describes the entity and type representations for common items that the List API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.
Represents request to create a list filtered to a set of unique record identifiers
The AppendIdsToList entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| list_id | Property is required | string string | The immutable system record ID for the list | |
| ids | Property is required | array of string array of string | The unique identifiers for the records to be added to the list. Limited to a maximumum 100,000 identifiers. |
Represents a request to create a list filtered to a set of unique record identifiers
The CreateListFromIdsRequest entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| name | Property is required | string string | The name of the list | |
| description | Property is required | string string | The description of the list | |
| list_type | Property is required | string string | Determines the type of list to create. Currently supports 'Constituent', 'Gift', 'Action', 'Opportunity'.
| |
| list_permissions | Property is required | string string | Determines whether other users can access the list. Currently supports 'OnlyOwnerCanAccess', 'OthersCanView', 'OthersCanViewAndEdit'.
| |
| ids | Property is required | array of string array of string | The unique identifiers for the records contained in the list. Limited to a maximumum 100,000 identifiers. |
Represents response when creating a list from a set of unique record identifiers
The CreateListFromIdsResponse entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | The identifier for the new list |
Represents the List entity
The List entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | The immutable system record ID for the list | |
| name | Property is required | string string | The name of the list | |
| description | Property is required | string string | The description of the list | |
| record_count | Property is required | integer integer | The total number of records defined by this list based on the last time this list was saved | |
| date_modified | Property is required | datetime datetime | The date this list was last modified. Uses ISO-8601 format: 1969-11-21T10:29:43 | |
| last_modified_by_user_name | Property is required | string string | The name of the user that last modified the list | |
| last_modified_by_user_id | Property is required | string string | The ID of the user that last modified the list | |
| is_public | Property is required | boolean boolean | Indicates whether this is a public or private list. |
Represents the list of lists entity
The Lists entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The total number of lists in the set | |
| value | Property is required | array of list array of list | Represents the List entity |