Members
Partners
Export recently-modified members by organization. Roles: partner admin.
Get all org members who have been modified since a given date. Each returned member will include their profile responses (attributes), groups, dependent members, programs, and courses.
Query parameters:
- modifiedSince (required, format is yyyy-MM-dd)
- pageIndex (required, integer, first page is 0)
- pageSize (required, integer, max size is 1000)
Response:
- Array of members modified since the given date
- Program statuses:
- NOT_STARTED
- User enrolled but requirements have not been started.
- IN_PROGRESS
- User started at least one requirement.
- COMPLETED
- All requirements for the program have been satisfied.
- FAILED
- At least one of the requirements has failed (usually only used for background checks).
- EXPIRED
- Program must be renewed or at least one requirement must be restarted
- NOT_STARTED
- Course statuses:
- NOT_STARTED
- IN_PROGRESS
- COMPLETED
Notes:
- A member will be included if any of the returned data has been modified since the given date. For instance, if the user completed a course on 2023-04-01, their entire record will be included when requesting an export since 2023-04-01.
- Results are paginated. The maximum page size is 1000.
- If Mobile Coach is using your system as an identity provider (IdP), your member/user/account ID may be returned as a “profile response” or as an "externalId" or “username” to help your integration map Mobile Coach member accounts to your system. Please contact support@newstartmobile.com for details on your integration.
get/api/partners/orgs/{orgId}/members/export
Path parameters
orgIdinteger required
Query parameters
modifiedSincestring required
yyyy-MM-dd
pageIndexinteger
Page Index (starts at zero)
pageSizeinteger
Page Size (max 1000)
Response
OK
Changes
No recorded changes to this endpoint across all 1 revision of this API.