Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 855 Bytes

list_user_emails.md

File metadata and controls

37 lines (31 loc) · 855 Bytes

GET "/v1/list_user_emails/"

This endpoint lists the emails of users affiliated with the requester's agencies

Sample Request

/v1/list_user_emails/

Request Params

N/A

Response (JSON)

{
    "users": [
        {
            "id": 1,
            "name": "User 1",
            "email": "[email protected]"
        },
        {
            "id": 5,
            "name": "Another User",
            "email": "[email protected]"
        }
    ]
}

Response Attributes

  • users: ([dict]) the list of users and emails that the requester has access to. Contents of the dictionaries are:
    • id: (integer) the ID of the user as stored in the database
    • name: (string) the name of the user
    • email: (string) the email of the user

Errors

Possible HTTP Status Codes:

  • 401: Login required