Members
Partners

Search members by external ID, profile response, or email.

Changed on

To search for a member, you must choose a field key and provide a value.

Field Keys:

  • EMAIL - search by email address (case-insensitive)
  • EXTERNAL_ID - search by the member's unique ID provided by your system
    • (this is only used if you system is the identity provider for the organization)
  • USERNAME - search by username (case-insensitive)
  • MEMBER_NUMBER - (DEPRECATED; use USERNAME instead) search by username (case-insensitive)
  • PROFILE_RESPONSE - search by the response to a custom attribute or "profile question"

When searching by PROFILE_RESPONSE, you must also specify the question (attribute):

  • questionId (defined by Mobile Coach)
  • externalReferenceId (defined via the admin console)

Notes:

  • The search may return more than one result.
post/api/partners/orgs/{orgId}/members/search

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/partners/orgs/{orgId}/members/search
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

orgIdinteger required

Request body

fieldKey'EMAIL' | 'EXTERNAL_ID' | 'MEMBER_NUMBER' | 'PROFILE_RESPONSE' | 'USERNAME' required
questionIdinteger
externalReferenceIdstring
valuestring required

Response

OK

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status