Corrily home pagelight logo
Users
Get User country
GET

/v1/users/{user_id}

X-Api-Key*
curl --request GET \
  --url https://client.corrily.com/v1/users/{user_id} \
  --header 'X-Api-Key: <x-api-key>'

This endpoint returns the country for the user if the user exists. If the user does not exist, it returns an 400 error.

​
Path Params

user_idrequired
string

A User ID.

​
Body Params

​
Response

user
object

Object containing user details

error_message
string

Details of the error if response is not a success response

success
string

Has the value false if the response is not a success

curl --request GET \
     --url 'https://client.corrily.com/v1/users/test_user_id' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json'

{
    "user": {
        "country": "AU"
    }
}

{
    "success": false,
    "error_message": "User does not exist"
}