CYcyberimpact
Members

Retrieve members

Retrieve a paginated list of your members.

Active members are subscribed members that are part of group(s). Orphan members are subscribed members that are not part of a group.

Note: The returned property items_per_page is deprecated and will eventually be removed. Use limit instead.

get/members

Request

Query parameters

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

status'active' | 'orphans' | 'all'

The status of the member in your account

sort'email_asc' | 'email_desc' | 'language_asc' | 'language_desc' | 'fullname_asc' | 'fullname_desc' | 'date_asc' | 'date_desc' | 'consent_type_asc' | 'consent_type_desc' | 'consent_date_asc' | 'consent_date_desc' | 'updated_asc' | 'updated_desc'

Sort order for results

joinedOnFromstring date

Date (start of day) from which members were added (format: yyyy-mm-dd)

joinedOnTostring date

Date (end of day) to which members were added (format: yyyy-mm-dd)

updatedOnFromstring date

Date (start of day) from which members were last updated (format: yyyy-mm-dd)

updatedOnTostring date

Date (end of day) to which members were last updated (format: yyyy-mm-dd)

Response

Paginated list of members

totalCountinteger
pageinteger
limitinteger
items_per_pageinteger

Deprecated — use limit instead

sortstring

Example response

{
  "members": [
    {
      "id": 3664823,
      "firstname": "John",
      "lastname": "Doe",
      "company": "John Doe Company inc",
      "email": "john.doe@example.org",
      "gender": "m",
      "language": "fr_ca",
      "joinedOn": "2014-12-09 13:42:48.020",
      "updatedOn": "2014-12-10 12:41:42.020",
      "consentType": "implied",
      "country": "CA",
      "customFields": {
        "1": "This is a test !",
        "2": 1000,
        "3": 1.5,
        "4": "2000-01-01"
      }
    }
  ],
  "totalCount": 304711,
  "page": 1,
  "limit": 2,
  "items_per_page": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.