Users | Hitchhikers

Users: List

Lists all Users in an account.

NOTE:

If the v parameter is before 20190225: displayLanguagePreference and emailLanguagePreference will not be included in the response.

If the v parameter is 20190225 or later: displayLanguagePreference and emailLanguagePreference will be included in the response.

This endpoint does not support the all macro.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"users": [{"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"lastLoginDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
]
}
]
}
}

Users: Create

Create a new User

NOTE:

If the v parameter is before 20190225: displayLanguagePreference and emailLanguagePreference will not be accepted in the request body.

If the v parameter is 20190225 or later: displayLanguagePreference and emailLanguagePreference will be accepted in the request body.

path Parameters

accountId

required

string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id required	string ID of this User. Ignored when sent in update requests.
firstName required	string User's first name.
lastName required	string User's last name.
emailAddress required	string User's email address.
phoneNumber	string User's phone number.
emailLanguagePreference	string User's preferred email language. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used.
displayLanguagePreference	string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used.
lastLoginDate	string User's last login time in UNIX timestamp
sso	boolean Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our Implementing Single Sign-On guide. Defaults to false.
	Array of objects If the `v` parameter is before `20211115` acl entries are not returned for non-location entities
password	string User's password.
username	string User's username.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"lastLoginDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"password": "string",
"username": "string"
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Users: Get

Retrieves details of a specific User.

NOTE:

If the v parameter is before 20190225: displayLanguagePreference and emailLanguagePreference will not be included in the response.

If the v parameter is 20190225 or later: displayLanguagePreference and emailLanguagePreference will be included in the response.

path Parameters

accountId required	string
userId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"lastLoginDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
]
}
}

Users: Update

Updates an existing User.

NOTE:

If the v parameter is before 20190225: displayLanguagePreference and emailLanguagePreference will not be accepted in the request body.

If the v parameter is 20190225 or later: displayLanguagePreference and emailLanguagePreference will be accepted in the request body. If not provided, existing values will be cleared.

path Parameters

accountId required	string
userId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id required	string ID of this User. Ignored when sent in update requests.
firstName required	string User's first name.
lastName required	string User's last name.
emailAddress required	string User's email address.
phoneNumber	string User's phone number.
emailLanguagePreference	string User's preferred email language. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used.
displayLanguagePreference	string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used.
lastLoginDate	string User's last login time in UNIX timestamp
sso	boolean Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our Implementing Single Sign-On guide. Defaults to false.
	Array of objects If the `v` parameter is before `20211115` acl entries are not returned for non-location entities
username required	string User's username.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"lastLoginDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"username": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Users: Delete

Deletes an existing User.

path Parameters

accountId required	string
userId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Users: Update Password

Updates a User's password.

path Parameters

accountId required	string
userId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

newPassword

required

string

User's new password

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}